National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build
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
| 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 | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.43.42.50 | |||||
This profile enables NDH to capture verification provenance, status, and timing for directory data so consumers can assess trust, recency, and validation method when making decisions based on published provider, organization, and role information; it applies ValueSet bindings for validation type, process, primary-source type, and communication method to normalize attestation workflows.
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.
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.
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:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  VerificationResult |
0..* | VerificationResult | Verification | |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 target |
1..* | Reference(Resource) | The resource instance was verified or attested | |
 need |
1..1 | CodeableConcept | none | initial | periodic Binding: need (preferred): The frequency with which the target must be validated. | |
| status |
1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail Binding: status (required): The validation status of the target. | |
| statusDate |
1..1 | dateTime | When the validation status was updated | |
| validationType |
1..1 | CodeableConcept | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing Binding: validation-type (required) | |
| validationProcess |
1..* | CodeableConcept | The process(es) by which the target was verified Binding: NDH Verification Process Value Set (extensible) | |
| frequency |
0..1 | Timing | Frequency of verification | |
| lastPerformed |
0..1 | dateTime | The date/time verification was last completed (including failed verifications) | |
| nextScheduled |
0..1 | date | The date when target is next verified, if appropriate | |
| failureAction |
1..1 | CodeableConcept | fatal | warn | rec-only | none Binding: failure-action (preferred): The result if validation fails. | |
 primarySource |
0..* | BackboneElement | Information about the primary source(s) involved in validation | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| who |
0..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | Reference to the primary source | |
| type |
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 |
0..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult_communication_method (1.0.0) (extensible) | |
| validationStatus |
0..1 | CodeableConcept | successful | failed | unknown Binding: validation-status (preferred): Status of the validation of the target against the primary source. | |
| validationDate |
0..1 | dateTime | When the target was validated against the primary source | |
| canPushUpdates |
0..1 | CodeableConcept | yes | no | undetermined Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts. | |
 pushTypeAvailable |
0..* | CodeableConcept | specific | any | source Binding: push-type-available (preferred): Type of alerts/updates the primary source can send. | |
| attestation |
1..1 | BackboneElement | Information about the entity attesting to information | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| who |
1..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | The individual or organization attesting to information | |
| onBehalfOf |
0..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | When the who is asserting on behalf of another (organization or individual) | |
| communicationMethod |
1..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult_communication_method (1.0.0) (extensible) | |
| date |
1..1 | date | The date the information was attested to | |
| sourceIdentityCertificate |
0..1 | string | A digital identity certificate associated with the attestation source | |
| proxyIdentityCertificate |
0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source | |
| proxySignature |
0..1 | Signature | Proxy signature | |
| sourceSignature |
0..1 | Signature | Attester signature | |
 validator |
0..* | BackboneElement | Information about the entity validating information | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| organization |
1..1 | Reference(NDH Organization Profile) | Reference to the organization validating information | |
| identityCertificate |
0..1 | string | A digital identity certificate associated with the validator | |
| attestationSignature |
0..1 | Signature | Validator signature | |
| Documentation for this format | ||||
| 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.4 |
| 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.4 |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from VerificationResult
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| VerificationResult |
0..* | VerificationResult | Verification | |
 target |
1..* | Reference(Resource) | The resource instance was verified or attested | |
| targetLocation |
0..0 | The fhirpath location(s) within the resource that was validated | ||
| need |
1..1 | CodeableConcept | none | initial | periodic | |
| status |
1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail | |
| statusDate |
1..1 | dateTime | When the validation status was updated | |
| validationType |
1..1 | CodeableConcept | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing Binding: validation-type (required) | |
| validationProcess |
1..* | CodeableConcept | The process(es) by which the target was verified Binding: NDH Verification Process Value Set (extensible) | |
| frequency |
0..1 | Timing | Frequency of verification | |
| lastPerformed |
0..1 | dateTime | The date/time verification was last completed (including failed verifications) | |
| nextScheduled |
0..1 | date | The date when target is next verified, if appropriate | |
| failureAction |
1..1 | CodeableConcept | fatal | warn | rec-only | none | |
| primarySource |
0..* | BackboneElement | Information about the primary source(s) involved in validation | |
| who |
0..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | Reference to the primary source | |
| type |
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 |
0..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult_communication_method (1.0.0) (extensible) | |
| validationStatus |
0..1 | CodeableConcept | successful | failed | unknown | |
| validationDate |
0..1 | dateTime | When the target was validated against the primary source | |
| canPushUpdates |
0..1 | CodeableConcept | yes | no | undetermined | |
| pushTypeAvailable |
0..* | CodeableConcept | specific | any | source | |
| attestation |
1..1 | BackboneElement | Information about the entity attesting to information | |
| who |
1..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | The individual or organization attesting to information | |
| onBehalfOf |
0..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | When the who is asserting on behalf of another (organization or individual) | |
| communicationMethod |
1..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult_communication_method (1.0.0) (extensible) | |
| date |
1..1 | date | The date the information was attested to | |
| sourceIdentityCertificate |
0..1 | string | A digital identity certificate associated with the attestation source | |
| proxyIdentityCertificate |
0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source | |
| proxySignature |
0..1 | Signature | Proxy signature | |
| sourceSignature |
0..1 | Signature | Attester signature | |
| validator |
0..* | BackboneElement | Information about the entity validating information | |
| organization |
1..1 | Reference(NDH Organization Profile) | Reference to the organization validating information | |
| identityCertificate |
0..1 | string | A digital identity certificate associated with the validator | |
| attestationSignature |
0..1 | Signature | Validator signature | |
| Documentation for this format | ||||
| 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.4 |
| VerificationResult.attestation.communicationMethod | Base | extensible | VerificationResult Communication Method | 📍1.0.0 | THO v7.4 |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| target |
1..* | Reference(Resource) | The resource instance was verified or attested | |||||
| need |
1..1 | CodeableConcept | none | initial | periodic Binding: need (preferred): The frequency with which the target must be validated. | |||||
| status |
1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail Binding: status (required): The validation status of the target. | |||||
| statusDate |
1..1 | dateTime | When the validation status was updated | |||||
| validationType |
1..1 | CodeableConcept | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing Binding: validation-type (required) | |||||
| validationProcess |
1..* | CodeableConcept | The process(es) by which the target was verified Binding: NDH Verification Process Value Set (extensible) | |||||
| frequency |
0..1 | Timing | Frequency of verification | |||||
| lastPerformed |
0..1 | dateTime | The date/time verification was last completed (including failed verifications) | |||||
| nextScheduled |
0..1 | date | The date when target is next verified, if appropriate | |||||
| failureAction |
1..1 | CodeableConcept | fatal | warn | rec-only | none Binding: failure-action (preferred): The result if validation fails. | |||||
| primarySource |
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 |
0..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | Reference to the primary source | |||||
| type |
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 |
0..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult_communication_method (1.0.0) (extensible) | |||||
| validationStatus |
0..1 | CodeableConcept | successful | failed | unknown Binding: validation-status (preferred): Status of the validation of the target against the primary source. | |||||
| validationDate |
0..1 | dateTime | When the target was validated against the primary source | |||||
| canPushUpdates |
0..1 | CodeableConcept | yes | no | undetermined Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts. | |||||
| pushTypeAvailable |
0..* | CodeableConcept | specific | any | source Binding: push-type-available (preferred): Type of alerts/updates the primary source can send. | |||||
| attestation |
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 |
1..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | The individual or organization attesting to information | |||||
| onBehalfOf |
0..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | When the who is asserting on behalf of another (organization or individual) | |||||
| communicationMethod |
1..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult_communication_method (1.0.0) (extensible) | |||||
| date |
1..1 | date | The date the information was attested to | |||||
| sourceIdentityCertificate |
0..1 | string | A digital identity certificate associated with the attestation source | |||||
| proxyIdentityCertificate |
0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source | |||||
| proxySignature |
0..1 | Signature | Proxy signature | |||||
| sourceSignature |
0..1 | Signature | Attester signature | |||||
| validator |
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 |
1..1 | Reference(NDH Organization Profile) | Reference to the organization validating information | |||||
| identityCertificate |
0..1 | string | A digital identity certificate associated with the validator | |||||
| attestationSignature |
0..1 | Signature | Validator signature | |||||
| Documentation for this format | ||||||||
| 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.4 |
| 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.4 |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from VerificationResult
Summary
Mandatory: 10 elements(1 nested mandatory element)
Must-Support: 31 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Maturity: 4
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| VerificationResult |
0..* | VerificationResult | Verification | |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| target |
1..* | Reference(Resource) | The resource instance was verified or attested | |
| need |
1..1 | CodeableConcept | none | initial | periodic Binding: need (preferred): The frequency with which the target must be validated. | |
| status |
1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail Binding: status (required): The validation status of the target. | |
| statusDate |
1..1 | dateTime | When the validation status was updated | |
| validationType |
1..1 | CodeableConcept | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing Binding: validation-type (required) | |
| validationProcess |
1..* | CodeableConcept | The process(es) by which the target was verified Binding: NDH Verification Process Value Set (extensible) | |
| frequency |
0..1 | Timing | Frequency of verification | |
| lastPerformed |
0..1 | dateTime | The date/time verification was last completed (including failed verifications) | |
| nextScheduled |
0..1 | date | The date when target is next verified, if appropriate | |
| failureAction |
1..1 | CodeableConcept | fatal | warn | rec-only | none Binding: failure-action (preferred): The result if validation fails. | |
| primarySource |
0..* | BackboneElement | Information about the primary source(s) involved in validation | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| who |
0..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | Reference to the primary source | |
| type |
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 |
0..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult_communication_method (1.0.0) (extensible) | |
| validationStatus |
0..1 | CodeableConcept | successful | failed | unknown Binding: validation-status (preferred): Status of the validation of the target against the primary source. | |
| validationDate |
0..1 | dateTime | When the target was validated against the primary source | |
| canPushUpdates |
0..1 | CodeableConcept | yes | no | undetermined Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts. | |
| pushTypeAvailable |
0..* | CodeableConcept | specific | any | source Binding: push-type-available (preferred): Type of alerts/updates the primary source can send. | |
| attestation |
1..1 | BackboneElement | Information about the entity attesting to information | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| who |
1..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | The individual or organization attesting to information | |
| onBehalfOf |
0..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | When the who is asserting on behalf of another (organization or individual) | |
| communicationMethod |
1..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult_communication_method (1.0.0) (extensible) | |
| date |
1..1 | date | The date the information was attested to | |
| sourceIdentityCertificate |
0..1 | string | A digital identity certificate associated with the attestation source | |
| proxyIdentityCertificate |
0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source | |
| proxySignature |
0..1 | Signature | Proxy signature | |
| sourceSignature |
0..1 | Signature | Attester signature | |
| validator |
0..* | BackboneElement | Information about the entity validating information | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| organization |
1..1 | Reference(NDH Organization Profile) | Reference to the organization validating information | |
| identityCertificate |
0..1 | string | A digital identity certificate associated with the validator | |
| attestationSignature |
0..1 | Signature | Validator signature | |
| Documentation for this format | ||||
| 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.4 |
| 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.4 |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from VerificationResult
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| VerificationResult |
0..* | VerificationResult | Verification | |
| target |
1..* | Reference(Resource) | The resource instance was verified or attested | |
| targetLocation |
0..0 | The fhirpath location(s) within the resource that was validated | ||
| need |
1..1 | CodeableConcept | none | initial | periodic | |
| status |
1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail | |
| statusDate |
1..1 | dateTime | When the validation status was updated | |
| validationType |
1..1 | CodeableConcept | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing Binding: validation-type (required) | |
| validationProcess |
1..* | CodeableConcept | The process(es) by which the target was verified Binding: NDH Verification Process Value Set (extensible) | |
| frequency |
0..1 | Timing | Frequency of verification | |
| lastPerformed |
0..1 | dateTime | The date/time verification was last completed (including failed verifications) | |
| nextScheduled |
0..1 | date | The date when target is next verified, if appropriate | |
| failureAction |
1..1 | CodeableConcept | fatal | warn | rec-only | none | |
| primarySource |
0..* | BackboneElement | Information about the primary source(s) involved in validation | |
| who |
0..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | Reference to the primary source | |
| type |
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 |
0..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult_communication_method (1.0.0) (extensible) | |
| validationStatus |
0..1 | CodeableConcept | successful | failed | unknown | |
| validationDate |
0..1 | dateTime | When the target was validated against the primary source | |
| canPushUpdates |
0..1 | CodeableConcept | yes | no | undetermined | |
| pushTypeAvailable |
0..* | CodeableConcept | specific | any | source | |
| attestation |
1..1 | BackboneElement | Information about the entity attesting to information | |
| who |
1..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | The individual or organization attesting to information | |
| onBehalfOf |
0..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | When the who is asserting on behalf of another (organization or individual) | |
| communicationMethod |
1..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult_communication_method (1.0.0) (extensible) | |
| date |
1..1 | date | The date the information was attested to | |
| sourceIdentityCertificate |
0..1 | string | A digital identity certificate associated with the attestation source | |
| proxyIdentityCertificate |
0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source | |
| proxySignature |
0..1 | Signature | Proxy signature | |
| sourceSignature |
0..1 | Signature | Attester signature | |
| validator |
0..* | BackboneElement | Information about the entity validating information | |
| organization |
1..1 | Reference(NDH Organization Profile) | Reference to the organization validating information | |
| identityCertificate |
0..1 | string | A digital identity certificate associated with the validator | |
| attestationSignature |
0..1 | Signature | Validator signature | |
| Documentation for this format | ||||
| 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.4 |
| VerificationResult.attestation.communicationMethod | Base | extensible | VerificationResult Communication Method | 📍1.0.0 | THO v7.4 |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| target |
1..* | Reference(Resource) | The resource instance was verified or attested | |||||
| need |
1..1 | CodeableConcept | none | initial | periodic Binding: need (preferred): The frequency with which the target must be validated. | |||||
| status |
1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail Binding: status (required): The validation status of the target. | |||||
| statusDate |
1..1 | dateTime | When the validation status was updated | |||||
| validationType |
1..1 | CodeableConcept | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing Binding: validation-type (required) | |||||
| validationProcess |
1..* | CodeableConcept | The process(es) by which the target was verified Binding: NDH Verification Process Value Set (extensible) | |||||
| frequency |
0..1 | Timing | Frequency of verification | |||||
| lastPerformed |
0..1 | dateTime | The date/time verification was last completed (including failed verifications) | |||||
| nextScheduled |
0..1 | date | The date when target is next verified, if appropriate | |||||
| failureAction |
1..1 | CodeableConcept | fatal | warn | rec-only | none Binding: failure-action (preferred): The result if validation fails. | |||||
| primarySource |
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 |
0..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | Reference to the primary source | |||||
| type |
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 |
0..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult_communication_method (1.0.0) (extensible) | |||||
| validationStatus |
0..1 | CodeableConcept | successful | failed | unknown Binding: validation-status (preferred): Status of the validation of the target against the primary source. | |||||
| validationDate |
0..1 | dateTime | When the target was validated against the primary source | |||||
| canPushUpdates |
0..1 | CodeableConcept | yes | no | undetermined Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts. | |||||
| pushTypeAvailable |
0..* | CodeableConcept | specific | any | source Binding: push-type-available (preferred): Type of alerts/updates the primary source can send. | |||||
| attestation |
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 |
1..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | The individual or organization attesting to information | |||||
| onBehalfOf |
0..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | When the who is asserting on behalf of another (organization or individual) | |||||
| communicationMethod |
1..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult_communication_method (1.0.0) (extensible) | |||||
| date |
1..1 | date | The date the information was attested to | |||||
| sourceIdentityCertificate |
0..1 | string | A digital identity certificate associated with the attestation source | |||||
| proxyIdentityCertificate |
0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source | |||||
| proxySignature |
0..1 | Signature | Proxy signature | |||||
| sourceSignature |
0..1 | Signature | Attester signature | |||||
| validator |
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 |
1..1 | Reference(NDH Organization Profile) | Reference to the organization validating information | |||||
| identityCertificate |
0..1 | string | A digital identity certificate associated with the validator | |||||
| attestationSignature |
0..1 | Signature | Validator signature | |||||
| Documentation for this format | ||||||||
| 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.4 |
| 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.4 |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from VerificationResult
Summary
Mandatory: 10 elements(1 nested mandatory element)
Must-Support: 31 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Maturity: 4
Other representations of profile: CSV, Excel, Schematron
| Name | Type | Description | Expression |
| attestation-who | reference |
Use this search parameter to find validation information for data that was attested to by the specified individual or organization. Applies to VerificationResult records. |
VerificationResult.attestation.who
|
| primarysource-type | token |
Use this search parameter to find verification information for data that was verified against the specified primary source type. Applies to VerificationResult records. |
VerificationResult.primarySource.type
|
| primarysource-validation-status | token |
Use this search parameter to find verification information for data that was verified against the specified primary source validation status. Applies to VerificationResult records. |
VerificationResult.primarySource.validationStatus
|
| primarysource-who | reference |
Use this search parameter to find verification information for data that was verified against the specified primary source actor. Applies to VerificationResult records. |
VerificationResult.primarySource.who
|
| status | token |
Use this search parameter to find verification information for data that was verified against the specified status. Applies to VerificationResult records. |
VerificationResult.status
|
| target | reference |
Use this search parameter to find verification information for data that was verified against the specified target. Applies to VerificationResult records. |
VerificationResult.target
|
| _include | Example |
|---|---|
| VerificationResult:verificationresult-target | GET [base]/VerificationResult?_include=VerificationResult:target |
| VerificationResult:verificationresult-attestation-who | GET [base]/VerificationResult?_include=VerificationResult:attestation-who |
None
IG © 2023+ HL7 International / Patient Administration.
Package hl7.fhir.us.ndh#2.0.0-current based on FHIR 4.0.1.
Generated
2026-10-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change