National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot
National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot
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 1.0.0-ballot 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: 1.0.0-ballot | |||
| Active as of 2023-01-22 | Computable Name: NdhVerification | |||
Copyright/Legal: HL7 International |
||||
Describes Verification requirements, source(s), status and dates for one or more elements
This profile sets minimum expectations for searching and/or fetching information associated with verification. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the VerificationResult resource when using this profile.
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 Restriction and Verification. Its purpose is to indicate the verification status of a given instance of an NDH resource.
The VerificationResult resource instances provide information on which verification process was performed, what was verified, when the verification took place, who performed the verification, and how it was verified for a given instance of a resource.
It is important to note that even if a resource instance has a verification status of “not-required,” there shall still be a VerificationResult resource instance associated with it. The VerificationResult would provide details on why the verification was not required, how it was determined that verification was not required, and any other relevant information related to the verification process.
| Verification | Value |
| .target | Location/123 |
| .need | none |
| .status | attested |
| .statusDate | 2023/04/04 |
| .validationType | nothing |
| .validationProcess | in-context |
| .failureAction | none |
| .attestation.who | Organization/123 |
| .attestation.communicationMetod | manual, portal |
| .attestation.date | 2023/04/04 |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from VerificationResult
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  VerificationResult | 0..* | VerificationResult | Verification | |
  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 Base Organization Profile | NDH Base Practitioner Profile | NDH Base 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 (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 Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | The individual or organization attesting to information |
| onBehalfOf | S | 0..1 | Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | When the who is asserting on behalf of another (organization or individual) |
| communicationMethod | S | 1..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult Communication Method (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 Base 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 | ||||
| Path | Conformance | ValueSet | URI |
| VerificationResult.validationType | required | validation-typehttp://hl7.org/fhir/ValueSet/verificationresult-validation-typefrom the FHIR Standard | |
| VerificationResult.validationProcess | extensible | NdhVerificationProcessVS (a valid code from NDH Verification Process Code System)http://hl7.org/fhir/us/ndh/ValueSet/NdhVerificationProcessVSfrom this IG | |
| VerificationResult.primarySource.type | extensible | primary-source-typehttp://hl7.org/fhir/ValueSet/verificationresult-primary-source-typefrom the FHIR Standard | |
| VerificationResult.primarySource.communicationMethod | extensible | VerificationResult_communication_methodhttp://terminology.hl7.org/ValueSet/verificationresult-communication-method | |
| VerificationResult.attestation.communicationMethod | extensible | VerificationResult_communication_methodhttp://terminology.hl7.org/ValueSet/verificationresult-communication-method |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | 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 Base Organization Profile | NDH Base Practitioner Profile | NDH Base 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 (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 Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | The individual or organization attesting to information |
| onBehalfOf | SΣ | 0..1 | Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | When the who is asserting on behalf of another (organization or individual) |
| communicationMethod | SΣ | 1..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult Communication Method (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 Base 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 | ||||
| Path | Conformance | ValueSet | URI |
| VerificationResult.need | preferred | needhttp://hl7.org/fhir/ValueSet/verificationresult-needfrom the FHIR Standard | |
| VerificationResult.status | required | statushttp://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1from the FHIR Standard | |
| VerificationResult.validationType | required | validation-typehttp://hl7.org/fhir/ValueSet/verificationresult-validation-typefrom the FHIR Standard | |
| VerificationResult.validationProcess | extensible | NdhVerificationProcessVS (a valid code from NDH Verification Process Code System)http://hl7.org/fhir/us/ndh/ValueSet/NdhVerificationProcessVSfrom this IG | |
| VerificationResult.failureAction | preferred | failure-actionhttp://hl7.org/fhir/ValueSet/verificationresult-failure-actionfrom the FHIR Standard | |
| VerificationResult.primarySource.type | extensible | primary-source-typehttp://hl7.org/fhir/ValueSet/verificationresult-primary-source-typefrom the FHIR Standard | |
| VerificationResult.primarySource.communicationMethod | extensible | VerificationResult_communication_methodhttp://terminology.hl7.org/ValueSet/verificationresult-communication-method | |
| VerificationResult.primarySource.validationStatus | preferred | validation-statushttp://hl7.org/fhir/ValueSet/verificationresult-validation-statusfrom the FHIR Standard | |
| VerificationResult.primarySource.canPushUpdates | preferred | can-push-updateshttp://hl7.org/fhir/ValueSet/verificationresult-can-push-updatesfrom the FHIR Standard | |
| VerificationResult.primarySource.pushTypeAvailable | preferred | push-type-availablehttp://hl7.org/fhir/ValueSet/verificationresult-push-type-availablefrom the FHIR Standard | |
| VerificationResult.attestation.communicationMethod | extensible | VerificationResult_communication_methodhttp://terminology.hl7.org/ValueSet/verificationresult-communication-method |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | |||||
| 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) | 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 Base Organization Profile | NDH Base Practitioner Profile | NDH Base 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 (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 Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | The individual or organization attesting to information | ||||
| onBehalfOf | SΣ | 0..1 | Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | When the who is asserting on behalf of another (organization or individual) | ||||
| communicationMethod | SΣ | 1..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult Communication Method (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 Base 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 | ||||||||
| Path | Conformance | ValueSet | URI | |||
| VerificationResult.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| VerificationResult.need | preferred | needhttp://hl7.org/fhir/ValueSet/verificationresult-needfrom the FHIR Standard | ||||
| VerificationResult.status | required | statushttp://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1from the FHIR Standard | ||||
| VerificationResult.validationType | required | validation-typehttp://hl7.org/fhir/ValueSet/verificationresult-validation-typefrom the FHIR Standard | ||||
| VerificationResult.validationProcess | extensible | NdhVerificationProcessVS (a valid code from NDH Verification Process Code System)http://hl7.org/fhir/us/ndh/ValueSet/NdhVerificationProcessVSfrom this IG | ||||
| VerificationResult.failureAction | preferred | failure-actionhttp://hl7.org/fhir/ValueSet/verificationresult-failure-actionfrom the FHIR Standard | ||||
| VerificationResult.primarySource.type | extensible | primary-source-typehttp://hl7.org/fhir/ValueSet/verificationresult-primary-source-typefrom the FHIR Standard | ||||
| VerificationResult.primarySource.communicationMethod | extensible | VerificationResult_communication_methodhttp://terminology.hl7.org/ValueSet/verificationresult-communication-method | ||||
| VerificationResult.primarySource.validationStatus | preferred | validation-statushttp://hl7.org/fhir/ValueSet/verificationresult-validation-statusfrom the FHIR Standard | ||||
| VerificationResult.primarySource.canPushUpdates | preferred | can-push-updateshttp://hl7.org/fhir/ValueSet/verificationresult-can-push-updatesfrom the FHIR Standard | ||||
| VerificationResult.primarySource.pushTypeAvailable | preferred | push-type-availablehttp://hl7.org/fhir/ValueSet/verificationresult-push-type-availablefrom the FHIR Standard | ||||
| VerificationResult.attestation.communicationMethod | extensible | VerificationResult_communication_methodhttp://terminology.hl7.org/ValueSet/verificationresult-communication-method |
This structure is derived from VerificationResult
Differential View
This structure is derived from VerificationResult
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| VerificationResult | 0..* | VerificationResult | Verification | |
| 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 Base Organization Profile | NDH Base Practitioner Profile | NDH Base 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 (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 Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | The individual or organization attesting to information |
| onBehalfOf | S | 0..1 | Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | When the who is asserting on behalf of another (organization or individual) |
| communicationMethod | S | 1..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult Communication Method (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 Base 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 | ||||
| Path | Conformance | ValueSet | URI |
| VerificationResult.validationType | required | validation-typehttp://hl7.org/fhir/ValueSet/verificationresult-validation-typefrom the FHIR Standard | |
| VerificationResult.validationProcess | extensible | NdhVerificationProcessVS (a valid code from NDH Verification Process Code System)http://hl7.org/fhir/us/ndh/ValueSet/NdhVerificationProcessVSfrom this IG | |
| VerificationResult.primarySource.type | extensible | primary-source-typehttp://hl7.org/fhir/ValueSet/verificationresult-primary-source-typefrom the FHIR Standard | |
| VerificationResult.primarySource.communicationMethod | extensible | VerificationResult_communication_methodhttp://terminology.hl7.org/ValueSet/verificationresult-communication-method | |
| VerificationResult.attestation.communicationMethod | extensible | VerificationResult_communication_methodhttp://terminology.hl7.org/ValueSet/verificationresult-communication-method |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 | 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 Base Organization Profile | NDH Base Practitioner Profile | NDH Base 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 (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 Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | The individual or organization attesting to information |
| onBehalfOf | SΣ | 0..1 | Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | When the who is asserting on behalf of another (organization or individual) |
| communicationMethod | SΣ | 1..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult Communication Method (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 Base 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 | ||||
| Path | Conformance | ValueSet | URI |
| VerificationResult.need | preferred | needhttp://hl7.org/fhir/ValueSet/verificationresult-needfrom the FHIR Standard | |
| VerificationResult.status | required | statushttp://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1from the FHIR Standard | |
| VerificationResult.validationType | required | validation-typehttp://hl7.org/fhir/ValueSet/verificationresult-validation-typefrom the FHIR Standard | |
| VerificationResult.validationProcess | extensible | NdhVerificationProcessVS (a valid code from NDH Verification Process Code System)http://hl7.org/fhir/us/ndh/ValueSet/NdhVerificationProcessVSfrom this IG | |
| VerificationResult.failureAction | preferred | failure-actionhttp://hl7.org/fhir/ValueSet/verificationresult-failure-actionfrom the FHIR Standard | |
| VerificationResult.primarySource.type | extensible | primary-source-typehttp://hl7.org/fhir/ValueSet/verificationresult-primary-source-typefrom the FHIR Standard | |
| VerificationResult.primarySource.communicationMethod | extensible | VerificationResult_communication_methodhttp://terminology.hl7.org/ValueSet/verificationresult-communication-method | |
| VerificationResult.primarySource.validationStatus | preferred | validation-statushttp://hl7.org/fhir/ValueSet/verificationresult-validation-statusfrom the FHIR Standard | |
| VerificationResult.primarySource.canPushUpdates | preferred | can-push-updateshttp://hl7.org/fhir/ValueSet/verificationresult-can-push-updatesfrom the FHIR Standard | |
| VerificationResult.primarySource.pushTypeAvailable | preferred | push-type-availablehttp://hl7.org/fhir/ValueSet/verificationresult-push-type-availablefrom the FHIR Standard | |
| VerificationResult.attestation.communicationMethod | extensible | VerificationResult_communication_methodhttp://terminology.hl7.org/ValueSet/verificationresult-communication-method |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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 | |||||
| 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) | 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 Base Organization Profile | NDH Base Practitioner Profile | NDH Base 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 (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 Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | The individual or organization attesting to information | ||||
| onBehalfOf | SΣ | 0..1 | Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | When the who is asserting on behalf of another (organization or individual) | ||||
| communicationMethod | SΣ | 1..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult Communication Method (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 Base 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 | ||||||||
| Path | Conformance | ValueSet | URI | |||
| VerificationResult.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| VerificationResult.need | preferred | needhttp://hl7.org/fhir/ValueSet/verificationresult-needfrom the FHIR Standard | ||||
| VerificationResult.status | required | statushttp://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1from the FHIR Standard | ||||
| VerificationResult.validationType | required | validation-typehttp://hl7.org/fhir/ValueSet/verificationresult-validation-typefrom the FHIR Standard | ||||
| VerificationResult.validationProcess | extensible | NdhVerificationProcessVS (a valid code from NDH Verification Process Code System)http://hl7.org/fhir/us/ndh/ValueSet/NdhVerificationProcessVSfrom this IG | ||||
| VerificationResult.failureAction | preferred | failure-actionhttp://hl7.org/fhir/ValueSet/verificationresult-failure-actionfrom the FHIR Standard | ||||
| VerificationResult.primarySource.type | extensible | primary-source-typehttp://hl7.org/fhir/ValueSet/verificationresult-primary-source-typefrom the FHIR Standard | ||||
| VerificationResult.primarySource.communicationMethod | extensible | VerificationResult_communication_methodhttp://terminology.hl7.org/ValueSet/verificationresult-communication-method | ||||
| VerificationResult.primarySource.validationStatus | preferred | validation-statushttp://hl7.org/fhir/ValueSet/verificationresult-validation-statusfrom the FHIR Standard | ||||
| VerificationResult.primarySource.canPushUpdates | preferred | can-push-updateshttp://hl7.org/fhir/ValueSet/verificationresult-can-push-updatesfrom the FHIR Standard | ||||
| VerificationResult.primarySource.pushTypeAvailable | preferred | push-type-availablehttp://hl7.org/fhir/ValueSet/verificationresult-push-type-availablefrom the FHIR Standard | ||||
| VerificationResult.attestation.communicationMethod | extensible | VerificationResult_communication_methodhttp://terminology.hl7.org/ValueSet/verificationresult-communication-method |
This structure is derived from VerificationResult
Other representations of profile: CSV, Excel, Schematron
| 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] |
None
| _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#1.0.0-ballot based on FHIR 4.0.1. Generated 2024-03-28
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change