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 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 | |||
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.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | VerificationResult | Verification dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 1..* | Reference(Resource) | The resource instance was verified or attested ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | string | The fhirpath location(s) within the resource instance that was verified or attested ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | none | initial | periodic Binding: need (preferred): The frequency with which the target must be validated. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail Binding: status (required): The validation status of the target. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | When the validation status was updated ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing Binding: validation-type (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | The process(es) by which the target was verified Binding: NDH Verification Process Value Set (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | Timing | Frequency of verification ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | dateTime | The date/time verification was last completed (including failed verifications) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | date | The date when target is next verified, if appropriate ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | fatal | warn | rec-only | none Binding: failure-action (preferred): The result if validation fails. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Information about the primary source(s) involved in validation ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | Reference to the primary source ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
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) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult Communication Method (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | successful | failed | unknown Binding: validation-status (preferred): Status of the validation of the target against the primary source. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | When the target was validated against the primary source ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | yes | no | undetermined Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | specific | any | source Binding: push-type-available (preferred): Type of alerts/updates the primary source can send. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Information about the entity attesting to information ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | The individual or organization attesting to information ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
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) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult Communication Method (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | date | The date the information was attested to ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | string | A digital identity certificate associated with the attestation source ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | Signature | Proxy signature ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | Signature | Attester signature ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Information about the entity validating information ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(NDH Base Organization Profile) | Reference to the organization validating information ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | string | A digital identity certificate associated with the validator ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | Signature | Validator signature ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
VerificationResult.need | preferred | needhttp://hl7.org/fhir/ValueSet/verificationresult-need from the FHIR Standard | |
VerificationResult.status | required | statushttp://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1 from the FHIR Standard | |
VerificationResult.validationType | required | validation-typehttp://hl7.org/fhir/ValueSet/verificationresult-validation-type from the FHIR Standard | |
VerificationResult.validationProcess | extensible | VerificationProcessVShttp://hl7.org/fhir/us/ndh/ValueSet/VerificationProcessVS from this IG | |
VerificationResult.failureAction | preferred | failure-actionhttp://hl7.org/fhir/ValueSet/verificationresult-failure-action from the FHIR Standard | |
VerificationResult.primarySource.type | extensible | primary-source-typehttp://hl7.org/fhir/ValueSet/verificationresult-primary-source-type from 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-status from the FHIR Standard | |
VerificationResult.primarySource.canPushUpdates | preferred | can-push-updateshttp://hl7.org/fhir/ValueSet/verificationresult-can-push-updates from the FHIR Standard | |
VerificationResult.primarySource.pushTypeAvailable | preferred | push-type-availablehttp://hl7.org/fhir/ValueSet/verificationresult-push-type-available from the FHIR Standard | |
VerificationResult.attestation.communicationMethod | extensible | VerificationResult_communication_methodhttp://terminology.hl7.org/ValueSet/verificationresult-communication-method |
This structure is derived from VerificationResult
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | VerificationResult | Verification | |
![]() ![]() ![]() |
S | 1..* | Reference(Resource) | The resource instance was verified or attested |
![]() ![]() ![]() |
S | 0..* | string | The fhirpath location(s) within the resource instance that was verified or attested |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | none | initial | periodic |
![]() ![]() ![]() |
S | 1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail |
![]() ![]() ![]() |
S | 1..1 | dateTime | When the validation status was updated |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing Binding: validation-type (required) |
![]() ![]() ![]() |
S | 1..* | CodeableConcept | The process(es) by which the target was verified Binding: NDH Verification Process Value Set (extensible) |
![]() ![]() ![]() |
S | 0..1 | Timing | Frequency of verification |
![]() ![]() ![]() |
S | 0..1 | dateTime | The date/time verification was last completed (including failed verifications) |
![]() ![]() ![]() |
S | 0..1 | date | The date when target is next verified, if appropriate |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | fatal | warn | rec-only | none |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Information about the primary source(s) involved in validation |
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | Reference to the primary source |
![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult Communication Method (extensible) |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | successful | failed | unknown |
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | When the target was validated against the primary source |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | yes | no | undetermined |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | specific | any | source |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Information about the entity attesting to information |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | The individual or organization attesting to information |
![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult Communication Method (extensible) |
![]() ![]() ![]() ![]() |
S | 1..1 | date | The date the information was attested to |
![]() ![]() ![]() ![]() |
S | 0..1 | string | A digital identity certificate associated with the attestation source |
![]() ![]() ![]() ![]() |
S | 0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source |
![]() ![]() ![]() ![]() |
S | 0..1 | Signature | Proxy signature |
![]() ![]() ![]() ![]() |
S | 0..1 | Signature | Attester signature |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Information about the entity validating information |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(NDH Base Organization Profile) | Reference to the organization validating information |
![]() ![]() ![]() ![]() |
S | 0..1 | string | A digital identity certificate associated with the validator |
![]() ![]() ![]() ![]() |
S | 0..1 | Signature | Validator signature |
![]() |
Path | Conformance | ValueSet | URI |
VerificationResult.validationType | required | validation-typehttp://hl7.org/fhir/ValueSet/verificationresult-validation-type from the FHIR Standard | |
VerificationResult.validationProcess | extensible | VerificationProcessVShttp://hl7.org/fhir/us/ndh/ValueSet/VerificationProcessVS from this IG | |
VerificationResult.primarySource.type | extensible | primary-source-typehttp://hl7.org/fhir/ValueSet/verificationresult-primary-source-type from 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![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | VerificationResult | Verification | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 1..* | Reference(Resource) | The resource instance was verified or attested | ||||
![]() ![]() ![]() |
SΣ | 0..* | string | The fhirpath location(s) within the resource instance that was verified or attested | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | none | initial | periodic Binding: need (preferred): The frequency with which the target must be validated. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail Binding: status (required): The validation status of the target. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | When the validation status was updated | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing Binding: validation-type (required) | ||||
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | The process(es) by which the target was verified Binding: NDH Verification Process Value Set (extensible) | ||||
![]() ![]() ![]() |
S | 0..1 | Timing | Frequency of verification | ||||
![]() ![]() ![]() |
S | 0..1 | dateTime | The date/time verification was last completed (including failed verifications) | ||||
![]() ![]() ![]() |
S | 0..1 | date | The date when target is next verified, if appropriate | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | fatal | warn | rec-only | none Binding: failure-action (preferred): The result if validation fails. | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Information about the primary source(s) involved in validation | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | Reference to the primary source | ||||
![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult Communication Method (extensible) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | successful | failed | unknown Binding: validation-status (preferred): Status of the validation of the target against the primary source. | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | When the target was validated against the primary source | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | yes | no | undetermined Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts. | ||||
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | specific | any | source Binding: push-type-available (preferred): Type of alerts/updates the primary source can send. | ||||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Information about the entity attesting to information | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | The individual or organization attesting to information | ||||
![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult Communication Method (extensible) | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | date | The date the information was attested to | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | A digital identity certificate associated with the attestation source | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Signature | Proxy signature | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Signature | Attester signature | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Information about the entity validating information | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(NDH Base Organization Profile) | Reference to the organization validating information | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | A digital identity certificate associated with the validator | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Signature | Validator signature | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
VerificationResult.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
VerificationResult.need | preferred | needhttp://hl7.org/fhir/ValueSet/verificationresult-need from the FHIR Standard | ||||
VerificationResult.status | required | statushttp://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1 from the FHIR Standard | ||||
VerificationResult.validationType | required | validation-typehttp://hl7.org/fhir/ValueSet/verificationresult-validation-type from the FHIR Standard | ||||
VerificationResult.validationProcess | extensible | VerificationProcessVShttp://hl7.org/fhir/us/ndh/ValueSet/VerificationProcessVS from this IG | ||||
VerificationResult.failureAction | preferred | failure-actionhttp://hl7.org/fhir/ValueSet/verificationresult-failure-action from the FHIR Standard | ||||
VerificationResult.primarySource.type | extensible | primary-source-typehttp://hl7.org/fhir/ValueSet/verificationresult-primary-source-type from 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-status from the FHIR Standard | ||||
VerificationResult.primarySource.canPushUpdates | preferred | can-push-updateshttp://hl7.org/fhir/ValueSet/verificationresult-can-push-updates from the FHIR Standard | ||||
VerificationResult.primarySource.pushTypeAvailable | preferred | push-type-availablehttp://hl7.org/fhir/ValueSet/verificationresult-push-type-available from the FHIR Standard | ||||
VerificationResult.attestation.communicationMethod | extensible | VerificationResult_communication_methodhttp://terminology.hl7.org/ValueSet/verificationresult-communication-method |
This structure is derived from VerificationResult
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | VerificationResult | Verification dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 1..* | Reference(Resource) | The resource instance was verified or attested ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..* | string | The fhirpath location(s) within the resource instance that was verified or attested ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | none | initial | periodic Binding: need (preferred): The frequency with which the target must be validated. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail Binding: status (required): The validation status of the target. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | When the validation status was updated ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing Binding: validation-type (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | The process(es) by which the target was verified Binding: NDH Verification Process Value Set (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | Timing | Frequency of verification ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | dateTime | The date/time verification was last completed (including failed verifications) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..1 | date | The date when target is next verified, if appropriate ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | fatal | warn | rec-only | none Binding: failure-action (preferred): The result if validation fails. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Information about the primary source(s) involved in validation ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | Reference to the primary source ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
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) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult Communication Method (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | successful | failed | unknown Binding: validation-status (preferred): Status of the validation of the target against the primary source. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | When the target was validated against the primary source ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | yes | no | undetermined Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | specific | any | source Binding: push-type-available (preferred): Type of alerts/updates the primary source can send. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Information about the entity attesting to information ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | The individual or organization attesting to information ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
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) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult Communication Method (extensible) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | date | The date the information was attested to ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | string | A digital identity certificate associated with the attestation source ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | Signature | Proxy signature ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | Signature | Attester signature ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Information about the entity validating information ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(NDH Base Organization Profile) | Reference to the organization validating information ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | string | A digital identity certificate associated with the validator ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | Signature | Validator signature ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
VerificationResult.need | preferred | needhttp://hl7.org/fhir/ValueSet/verificationresult-need from the FHIR Standard | |
VerificationResult.status | required | statushttp://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1 from the FHIR Standard | |
VerificationResult.validationType | required | validation-typehttp://hl7.org/fhir/ValueSet/verificationresult-validation-type from the FHIR Standard | |
VerificationResult.validationProcess | extensible | VerificationProcessVShttp://hl7.org/fhir/us/ndh/ValueSet/VerificationProcessVS from this IG | |
VerificationResult.failureAction | preferred | failure-actionhttp://hl7.org/fhir/ValueSet/verificationresult-failure-action from the FHIR Standard | |
VerificationResult.primarySource.type | extensible | primary-source-typehttp://hl7.org/fhir/ValueSet/verificationresult-primary-source-type from 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-status from the FHIR Standard | |
VerificationResult.primarySource.canPushUpdates | preferred | can-push-updateshttp://hl7.org/fhir/ValueSet/verificationresult-can-push-updates from the FHIR Standard | |
VerificationResult.primarySource.pushTypeAvailable | preferred | push-type-availablehttp://hl7.org/fhir/ValueSet/verificationresult-push-type-available from the FHIR Standard | |
VerificationResult.attestation.communicationMethod | extensible | VerificationResult_communication_methodhttp://terminology.hl7.org/ValueSet/verificationresult-communication-method |
Differential View
This structure is derived from VerificationResult
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | VerificationResult | Verification | |
![]() ![]() ![]() |
S | 1..* | Reference(Resource) | The resource instance was verified or attested |
![]() ![]() ![]() |
S | 0..* | string | The fhirpath location(s) within the resource instance that was verified or attested |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | none | initial | periodic |
![]() ![]() ![]() |
S | 1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail |
![]() ![]() ![]() |
S | 1..1 | dateTime | When the validation status was updated |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing Binding: validation-type (required) |
![]() ![]() ![]() |
S | 1..* | CodeableConcept | The process(es) by which the target was verified Binding: NDH Verification Process Value Set (extensible) |
![]() ![]() ![]() |
S | 0..1 | Timing | Frequency of verification |
![]() ![]() ![]() |
S | 0..1 | dateTime | The date/time verification was last completed (including failed verifications) |
![]() ![]() ![]() |
S | 0..1 | date | The date when target is next verified, if appropriate |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | fatal | warn | rec-only | none |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Information about the primary source(s) involved in validation |
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | Reference to the primary source |
![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult Communication Method (extensible) |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | successful | failed | unknown |
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | When the target was validated against the primary source |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | yes | no | undetermined |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | specific | any | source |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Information about the entity attesting to information |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | The individual or organization attesting to information |
![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult Communication Method (extensible) |
![]() ![]() ![]() ![]() |
S | 1..1 | date | The date the information was attested to |
![]() ![]() ![]() ![]() |
S | 0..1 | string | A digital identity certificate associated with the attestation source |
![]() ![]() ![]() ![]() |
S | 0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source |
![]() ![]() ![]() ![]() |
S | 0..1 | Signature | Proxy signature |
![]() ![]() ![]() ![]() |
S | 0..1 | Signature | Attester signature |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Information about the entity validating information |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(NDH Base Organization Profile) | Reference to the organization validating information |
![]() ![]() ![]() ![]() |
S | 0..1 | string | A digital identity certificate associated with the validator |
![]() ![]() ![]() ![]() |
S | 0..1 | Signature | Validator signature |
![]() |
Path | Conformance | ValueSet | URI |
VerificationResult.validationType | required | validation-typehttp://hl7.org/fhir/ValueSet/verificationresult-validation-type from the FHIR Standard | |
VerificationResult.validationProcess | extensible | VerificationProcessVShttp://hl7.org/fhir/us/ndh/ValueSet/VerificationProcessVS from this IG | |
VerificationResult.primarySource.type | extensible | primary-source-typehttp://hl7.org/fhir/ValueSet/verificationresult-primary-source-type from 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 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | VerificationResult | Verification | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 1..* | Reference(Resource) | The resource instance was verified or attested | ||||
![]() ![]() ![]() |
SΣ | 0..* | string | The fhirpath location(s) within the resource instance that was verified or attested | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | none | initial | periodic Binding: need (preferred): The frequency with which the target must be validated. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail Binding: status (required): The validation status of the target. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | When the validation status was updated | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing Binding: validation-type (required) | ||||
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | The process(es) by which the target was verified Binding: NDH Verification Process Value Set (extensible) | ||||
![]() ![]() ![]() |
S | 0..1 | Timing | Frequency of verification | ||||
![]() ![]() ![]() |
S | 0..1 | dateTime | The date/time verification was last completed (including failed verifications) | ||||
![]() ![]() ![]() |
S | 0..1 | date | The date when target is next verified, if appropriate | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | fatal | warn | rec-only | none Binding: failure-action (preferred): The result if validation fails. | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Information about the primary source(s) involved in validation | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | Reference to the primary source | ||||
![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult Communication Method (extensible) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | successful | failed | unknown Binding: validation-status (preferred): Status of the validation of the target against the primary source. | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | When the target was validated against the primary source | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | yes | no | undetermined Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts. | ||||
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | specific | any | source Binding: push-type-available (preferred): Type of alerts/updates the primary source can send. | ||||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Information about the entity attesting to information | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole) | The individual or organization attesting to information | ||||
![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult Communication Method (extensible) | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | date | The date the information was attested to | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | A digital identity certificate associated with the attestation source | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Signature | Proxy signature | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Signature | Attester signature | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Information about the entity validating information | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(NDH Base Organization Profile) | Reference to the organization validating information | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | A digital identity certificate associated with the validator | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Signature | Validator signature | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
VerificationResult.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
VerificationResult.need | preferred | needhttp://hl7.org/fhir/ValueSet/verificationresult-need from the FHIR Standard | ||||
VerificationResult.status | required | statushttp://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1 from the FHIR Standard | ||||
VerificationResult.validationType | required | validation-typehttp://hl7.org/fhir/ValueSet/verificationresult-validation-type from the FHIR Standard | ||||
VerificationResult.validationProcess | extensible | VerificationProcessVShttp://hl7.org/fhir/us/ndh/ValueSet/VerificationProcessVS from this IG | ||||
VerificationResult.failureAction | preferred | failure-actionhttp://hl7.org/fhir/ValueSet/verificationresult-failure-action from the FHIR Standard | ||||
VerificationResult.primarySource.type | extensible | primary-source-typehttp://hl7.org/fhir/ValueSet/verificationresult-primary-source-type from 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-status from the FHIR Standard | ||||
VerificationResult.primarySource.canPushUpdates | preferred | can-push-updateshttp://hl7.org/fhir/ValueSet/verificationresult-can-push-updates from the FHIR Standard | ||||
VerificationResult.primarySource.pushTypeAvailable | preferred | push-type-availablehttp://hl7.org/fhir/ValueSet/verificationresult-push-type-available from 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