This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
Patient Administration Work Group | Maturity Level: 1 | Trial Use | Security Category: Business | Compartments: No defined compartments |
Describes validation requirements, source(s), status and dates for one or more elements.
The VerificationResult can be used where content (such as found in a directory) is aggregated between systems,
and the details and results of this verification process needs to be recorded, to determine the likely accuracy/confidence in the content.
It does not represent the workflows or tasks related, but does cover the result of who did what when, why, and when it needs to be done again.
There are often multiple instances of the VerificationResult over time that reference the same resource, even if the resource has not changed, as the content was verified as still current. Alternately the process may discover that the content was no longer valid (i.e. the practitioner was not able to be verified was still working at the location) and therefore the instance could be updated to not be active, or even removed from the directory.
AuditEvent | Details of where/who the resource came from, along with technical data - typically system adminisrtrative data, often not externally accessible. |
Provenance | Business level details of where the content came from and what it can be used for. |
VerificationResult | Details of checks/workflow results that were performed to verify the accuracy of the referenced resource. This informs if the data should be trusted, or how current the information is. |
(A similar concept exists outside of healthcare in Art/Musical Equipment in Appraisals vs Provenance, the provenance of the piece covers its chain of ownership, where an appraisal covers how it was check for its authenticity)
Although the resource uses a Reference(any), the initial usage is in the directory space against:
Note to Implementers: Other resources may use this approach for verifying currency too, and may be updated to be included here in future versions of fhir, or in fhir implementation guides.
No references for this Resource.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
VerificationResult | TU | DomainResource | Describes validation requirements, source(s), status and dates for one or more elements Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
target | Σ | 0..* | Reference(Any) | A resource that was validated |
targetLocation | Σ | 0..* | string | The fhirpath location(s) within the resource that was validated |
need | Σ | 0..1 | CodeableConcept | none | initial | periodic Binding: need (Preferred) |
status | Σ | 1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail | entered-in-error Binding: Verification Result status (Required) |
statusDate | Σ | 0..1 | dateTime | When the validation status was updated |
validationType | Σ | 0..1 | CodeableConcept | nothing | primary | multiple Binding: validation-type (Preferred) |
validationProcess | Σ | 0..* | CodeableConcept | The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context) Binding: validation-process (Example) |
frequency | 0..1 | Timing | Frequency of revalidation | |
lastPerformed | 0..1 | dateTime | The date/time validation was last completed (including failed validations) | |
nextScheduled | 0..1 | date | The date when target is next validated, if appropriate | |
failureAction | Σ | 0..1 | CodeableConcept | fatal | warn | rec-only | none Binding: failure-action (Preferred) |
primarySource | 0..* | BackboneElement | Information about the primary source(s) involved in validation | |
who | 0..1 | Reference(Organization | Practitioner | PractitionerRole) | Reference to the primary source | |
type | Σ | 0..* | 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 (Example) |
communicationMethod | Σ | 0..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult Communication Method (Example) |
validationStatus | 0..1 | CodeableConcept | successful | failed | unknown Binding: validation-status (Preferred) | |
validationDate | 0..1 | dateTime | When the target was validated against the primary source | |
canPushUpdates | Σ | 0..1 | CodeableConcept | yes | no | undetermined Binding: can-push-updates (Preferred) |
pushTypeAvailable | 0..* | CodeableConcept | specific | any | source Binding: push-type-available (Preferred) | |
attestation | 0..1 | BackboneElement | Information about the entity attesting to information | |
who | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | The individual or organization attesting to information |
onBehalfOf | Σ | 0..1 | Reference(Organization | Practitioner | PractitionerRole) | When the who is asserting on behalf of another (organization or individual) |
communicationMethod | Σ | 0..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult Communication Method (Example) |
date | Σ | 0..1 | date | The date the information was attested to |
sourceIdentityCertificate | 0..1 | string | A digital identity certificate associated with the attestation source | |
proxyIdentityCertificate | 0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source | |
proxySignature | 0..1 | Signature | Proxy signature (digital or image) | |
sourceSignature | 0..1 | Signature | Attester signature (digital or image) | |
validator | 0..* | BackboneElement | Information about the entity validating information | |
organization | 1..1 | Reference(Organization) | Reference to the organization validating information | |
identityCertificate | 0..1 | string | A digital identity certificate associated with the validator | |
attestationSignature | 0..1 | Signature | Validator signature (digital or image) | |
Documentation for this format |
See the Extensions for this resource
UML Diagram (Legend)
XML Template
<VerificationResult xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <target><!-- 0..* Reference(Any) A resource that was validated --></target> <targetLocation value="[string]"/><!-- 0..* The fhirpath location(s) within the resource that was validated --> <need><!-- 0..1 CodeableConcept none | initial | periodic --></need> <status value="[code]"/><!-- 1..1 attested | validated | in-process | req-revalid | val-fail | reval-fail | entered-in-error --> <statusDate value="[dateTime]"/><!-- 0..1 When the validation status was updated --> <validationType><!-- 0..1 CodeableConcept nothing | primary | multiple --></validationType> <validationProcess><!-- 0..* CodeableConcept The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context) --></validationProcess> <frequency><!-- 0..1 Timing Frequency of revalidation --></frequency> <lastPerformed value="[dateTime]"/><!-- 0..1 The date/time validation was last completed (including failed validations) --> <nextScheduled value="[date]"/><!-- 0..1 The date when target is next validated, if appropriate --> <failureAction><!-- 0..1 CodeableConcept fatal | warn | rec-only | none --></failureAction> <primarySource> <!-- 0..* Information about the primary source(s) involved in validation --> <who><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Reference to the primary source --></who> <type><!-- 0..* CodeableConcept Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source) --></type> <communicationMethod><!-- 0..* CodeableConcept Method for exchanging information with the primary source --></communicationMethod> <validationStatus><!-- 0..1 CodeableConcept successful | failed | unknown --></validationStatus> <validationDate value="[dateTime]"/><!-- 0..1 When the target was validated against the primary source --> <canPushUpdates><!-- 0..1 CodeableConcept yes | no | undetermined --></canPushUpdates> <pushTypeAvailable><!-- 0..* CodeableConcept specific | any | source --></pushTypeAvailable> </primarySource> <attestation> <!-- 0..1 Information about the entity attesting to information --> <who><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) The individual or organization attesting to information --></who> <onBehalfOf><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) When the who is asserting on behalf of another (organization or individual) --></onBehalfOf> <communicationMethod><!-- 0..1 CodeableConcept The method by which attested information was submitted/retrieved --></communicationMethod> <date value="[date]"/><!-- 0..1 The date the information was attested to --> <sourceIdentityCertificate value="[string]"/><!-- 0..1 A digital identity certificate associated with the attestation source --> <proxyIdentityCertificate value="[string]"/><!-- 0..1 A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source --> <proxySignature><!-- 0..1 Signature Proxy signature (digital or image) --></proxySignature> <sourceSignature><!-- 0..1 Signature Attester signature (digital or image) --></sourceSignature> </attestation> <validator> <!-- 0..* Information about the entity validating information --> <organization><!-- 1..1 Reference(Organization) Reference to the organization validating information --></organization> <identityCertificate value="[string]"/><!-- 0..1 A digital identity certificate associated with the validator --> <attestationSignature><!-- 0..1 Signature Validator signature (digital or image) --></attestationSignature> </validator> </VerificationResult>
JSON Template
{ "resourceType" : "VerificationResult", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "target" : [{ Reference(Any) }], // A resource that was validated "targetLocation" : ["<string>"], // The fhirpath location(s) within the resource that was validated "need" : { CodeableConcept }, // none | initial | periodic "status" : "<code>", // R! attested | validated | in-process | req-revalid | val-fail | reval-fail | entered-in-error "statusDate" : "<dateTime>", // When the validation status was updated "validationType" : { CodeableConcept }, // nothing | primary | multiple "validationProcess" : [{ CodeableConcept }], // The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context) "frequency" : { Timing }, // Frequency of revalidation "lastPerformed" : "<dateTime>", // The date/time validation was last completed (including failed validations) "nextScheduled" : "<date>", // The date when target is next validated, if appropriate "failureAction" : { CodeableConcept }, // fatal | warn | rec-only | none "primarySource" : [{ // Information about the primary source(s) involved in validation "who" : { Reference(Organization|Practitioner|PractitionerRole) }, // Reference to the primary source "type" : [{ CodeableConcept }], // Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source) "communicationMethod" : [{ CodeableConcept }], // Method for exchanging information with the primary source "validationStatus" : { CodeableConcept }, // successful | failed | unknown "validationDate" : "<dateTime>", // When the target was validated against the primary source "canPushUpdates" : { CodeableConcept }, // yes | no | undetermined "pushTypeAvailable" : [{ CodeableConcept }] // specific | any | source }], "attestation" : { // Information about the entity attesting to information "who" : { Reference(Organization|Practitioner|PractitionerRole) }, // The individual or organization attesting to information "onBehalfOf" : { Reference(Organization|Practitioner|PractitionerRole) }, // When the who is asserting on behalf of another (organization or individual) "communicationMethod" : { CodeableConcept }, // The method by which attested information was submitted/retrieved "date" : "<date>", // The date the information was attested to "sourceIdentityCertificate" : "<string>", // A digital identity certificate associated with the attestation source "proxyIdentityCertificate" : "<string>", // A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source "proxySignature" : { Signature }, // Proxy signature (digital or image) "sourceSignature" : { Signature } // Attester signature (digital or image) }, "validator" : [{ // Information about the entity validating information "organization" : { Reference(Organization) }, // R! Reference to the organization validating information "identityCertificate" : "<string>", // A digital identity certificate associated with the validator "attestationSignature" : { Signature } // Validator signature (digital or image) }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:VerificationResult; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:target ( [ Reference(Any) ] ... ) ; # 0..* A resource that was validated fhir:targetLocation ( [ string ] ... ) ; # 0..* The fhirpath location(s) within the resource that was validated fhir:need [ CodeableConcept ] ; # 0..1 none | initial | periodic fhir:status [ code ] ; # 1..1 attested | validated | in-process | req-revalid | val-fail | reval-fail | entered-in-error fhir:statusDate [ dateTime ] ; # 0..1 When the validation status was updated fhir:validationType [ CodeableConcept ] ; # 0..1 nothing | primary | multiple fhir:validationProcess ( [ CodeableConcept ] ... ) ; # 0..* The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context) fhir:frequency [ Timing ] ; # 0..1 Frequency of revalidation fhir:lastPerformed [ dateTime ] ; # 0..1 The date/time validation was last completed (including failed validations) fhir:nextScheduled [ date ] ; # 0..1 The date when target is next validated, if appropriate fhir:failureAction [ CodeableConcept ] ; # 0..1 fatal | warn | rec-only | none fhir:primarySource ( [ # 0..* Information about the primary source(s) involved in validation fhir:who [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 Reference to the primary source fhir:type ( [ CodeableConcept ] ... ) ; # 0..* Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source) fhir:communicationMethod ( [ CodeableConcept ] ... ) ; # 0..* Method for exchanging information with the primary source fhir:validationStatus [ CodeableConcept ] ; # 0..1 successful | failed | unknown fhir:validationDate [ dateTime ] ; # 0..1 When the target was validated against the primary source fhir:canPushUpdates [ CodeableConcept ] ; # 0..1 yes | no | undetermined fhir:pushTypeAvailable ( [ CodeableConcept ] ... ) ; # 0..* specific | any | source ] ... ) ; fhir:attestation [ # 0..1 Information about the entity attesting to information fhir:who [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 The individual or organization attesting to information fhir:onBehalfOf [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 When the who is asserting on behalf of another (organization or individual) fhir:communicationMethod [ CodeableConcept ] ; # 0..1 The method by which attested information was submitted/retrieved fhir:date [ date ] ; # 0..1 The date the information was attested to fhir:sourceIdentityCertificate [ string ] ; # 0..1 A digital identity certificate associated with the attestation source fhir:proxyIdentityCertificate [ string ] ; # 0..1 A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source fhir:proxySignature [ Signature ] ; # 0..1 Proxy signature (digital or image) fhir:sourceSignature [ Signature ] ; # 0..1 Attester signature (digital or image) ] ; fhir:validator ( [ # 0..* Information about the entity validating information fhir:organization [ Reference(Organization) ] ; # 1..1 Reference to the organization validating information fhir:identityCertificate [ string ] ; # 0..1 A digital identity certificate associated with the validator fhir:attestationSignature [ Signature ] ; # 0..1 Validator signature (digital or image) ] ... ) ; ]
Changes from both R4 and R4B
VerificationResult | |
VerificationResult.status |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
VerificationResult | TU | DomainResource | Describes validation requirements, source(s), status and dates for one or more elements Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
target | Σ | 0..* | Reference(Any) | A resource that was validated |
targetLocation | Σ | 0..* | string | The fhirpath location(s) within the resource that was validated |
need | Σ | 0..1 | CodeableConcept | none | initial | periodic Binding: need (Preferred) |
status | Σ | 1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail | entered-in-error Binding: Verification Result status (Required) |
statusDate | Σ | 0..1 | dateTime | When the validation status was updated |
validationType | Σ | 0..1 | CodeableConcept | nothing | primary | multiple Binding: validation-type (Preferred) |
validationProcess | Σ | 0..* | CodeableConcept | The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context) Binding: validation-process (Example) |
frequency | 0..1 | Timing | Frequency of revalidation | |
lastPerformed | 0..1 | dateTime | The date/time validation was last completed (including failed validations) | |
nextScheduled | 0..1 | date | The date when target is next validated, if appropriate | |
failureAction | Σ | 0..1 | CodeableConcept | fatal | warn | rec-only | none Binding: failure-action (Preferred) |
primarySource | 0..* | BackboneElement | Information about the primary source(s) involved in validation | |
who | 0..1 | Reference(Organization | Practitioner | PractitionerRole) | Reference to the primary source | |
type | Σ | 0..* | 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 (Example) |
communicationMethod | Σ | 0..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult Communication Method (Example) |
validationStatus | 0..1 | CodeableConcept | successful | failed | unknown Binding: validation-status (Preferred) | |
validationDate | 0..1 | dateTime | When the target was validated against the primary source | |
canPushUpdates | Σ | 0..1 | CodeableConcept | yes | no | undetermined Binding: can-push-updates (Preferred) |
pushTypeAvailable | 0..* | CodeableConcept | specific | any | source Binding: push-type-available (Preferred) | |
attestation | 0..1 | BackboneElement | Information about the entity attesting to information | |
who | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | The individual or organization attesting to information |
onBehalfOf | Σ | 0..1 | Reference(Organization | Practitioner | PractitionerRole) | When the who is asserting on behalf of another (organization or individual) |
communicationMethod | Σ | 0..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: VerificationResult Communication Method (Example) |
date | Σ | 0..1 | date | The date the information was attested to |
sourceIdentityCertificate | 0..1 | string | A digital identity certificate associated with the attestation source | |
proxyIdentityCertificate | 0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source | |
proxySignature | 0..1 | Signature | Proxy signature (digital or image) | |
sourceSignature | 0..1 | Signature | Attester signature (digital or image) | |
validator | 0..* | BackboneElement | Information about the entity validating information | |
organization | 1..1 | Reference(Organization) | Reference to the organization validating information | |
identityCertificate | 0..1 | string | A digital identity certificate associated with the validator | |
attestationSignature | 0..1 | Signature | Validator signature (digital or image) | |
Documentation for this format |
See the Extensions for this resource
XML Template
<VerificationResult xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <target><!-- 0..* Reference(Any) A resource that was validated --></target> <targetLocation value="[string]"/><!-- 0..* The fhirpath location(s) within the resource that was validated --> <need><!-- 0..1 CodeableConcept none | initial | periodic --></need> <status value="[code]"/><!-- 1..1 attested | validated | in-process | req-revalid | val-fail | reval-fail | entered-in-error --> <statusDate value="[dateTime]"/><!-- 0..1 When the validation status was updated --> <validationType><!-- 0..1 CodeableConcept nothing | primary | multiple --></validationType> <validationProcess><!-- 0..* CodeableConcept The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context) --></validationProcess> <frequency><!-- 0..1 Timing Frequency of revalidation --></frequency> <lastPerformed value="[dateTime]"/><!-- 0..1 The date/time validation was last completed (including failed validations) --> <nextScheduled value="[date]"/><!-- 0..1 The date when target is next validated, if appropriate --> <failureAction><!-- 0..1 CodeableConcept fatal | warn | rec-only | none --></failureAction> <primarySource> <!-- 0..* Information about the primary source(s) involved in validation --> <who><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Reference to the primary source --></who> <type><!-- 0..* CodeableConcept Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source) --></type> <communicationMethod><!-- 0..* CodeableConcept Method for exchanging information with the primary source --></communicationMethod> <validationStatus><!-- 0..1 CodeableConcept successful | failed | unknown --></validationStatus> <validationDate value="[dateTime]"/><!-- 0..1 When the target was validated against the primary source --> <canPushUpdates><!-- 0..1 CodeableConcept yes | no | undetermined --></canPushUpdates> <pushTypeAvailable><!-- 0..* CodeableConcept specific | any | source --></pushTypeAvailable> </primarySource> <attestation> <!-- 0..1 Information about the entity attesting to information --> <who><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) The individual or organization attesting to information --></who> <onBehalfOf><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) When the who is asserting on behalf of another (organization or individual) --></onBehalfOf> <communicationMethod><!-- 0..1 CodeableConcept The method by which attested information was submitted/retrieved --></communicationMethod> <date value="[date]"/><!-- 0..1 The date the information was attested to --> <sourceIdentityCertificate value="[string]"/><!-- 0..1 A digital identity certificate associated with the attestation source --> <proxyIdentityCertificate value="[string]"/><!-- 0..1 A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source --> <proxySignature><!-- 0..1 Signature Proxy signature (digital or image) --></proxySignature> <sourceSignature><!-- 0..1 Signature Attester signature (digital or image) --></sourceSignature> </attestation> <validator> <!-- 0..* Information about the entity validating information --> <organization><!-- 1..1 Reference(Organization) Reference to the organization validating information --></organization> <identityCertificate value="[string]"/><!-- 0..1 A digital identity certificate associated with the validator --> <attestationSignature><!-- 0..1 Signature Validator signature (digital or image) --></attestationSignature> </validator> </VerificationResult>
JSON Template
{ "resourceType" : "VerificationResult", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "target" : [{ Reference(Any) }], // A resource that was validated "targetLocation" : ["<string>"], // The fhirpath location(s) within the resource that was validated "need" : { CodeableConcept }, // none | initial | periodic "status" : "<code>", // R! attested | validated | in-process | req-revalid | val-fail | reval-fail | entered-in-error "statusDate" : "<dateTime>", // When the validation status was updated "validationType" : { CodeableConcept }, // nothing | primary | multiple "validationProcess" : [{ CodeableConcept }], // The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context) "frequency" : { Timing }, // Frequency of revalidation "lastPerformed" : "<dateTime>", // The date/time validation was last completed (including failed validations) "nextScheduled" : "<date>", // The date when target is next validated, if appropriate "failureAction" : { CodeableConcept }, // fatal | warn | rec-only | none "primarySource" : [{ // Information about the primary source(s) involved in validation "who" : { Reference(Organization|Practitioner|PractitionerRole) }, // Reference to the primary source "type" : [{ CodeableConcept }], // Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source) "communicationMethod" : [{ CodeableConcept }], // Method for exchanging information with the primary source "validationStatus" : { CodeableConcept }, // successful | failed | unknown "validationDate" : "<dateTime>", // When the target was validated against the primary source "canPushUpdates" : { CodeableConcept }, // yes | no | undetermined "pushTypeAvailable" : [{ CodeableConcept }] // specific | any | source }], "attestation" : { // Information about the entity attesting to information "who" : { Reference(Organization|Practitioner|PractitionerRole) }, // The individual or organization attesting to information "onBehalfOf" : { Reference(Organization|Practitioner|PractitionerRole) }, // When the who is asserting on behalf of another (organization or individual) "communicationMethod" : { CodeableConcept }, // The method by which attested information was submitted/retrieved "date" : "<date>", // The date the information was attested to "sourceIdentityCertificate" : "<string>", // A digital identity certificate associated with the attestation source "proxyIdentityCertificate" : "<string>", // A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source "proxySignature" : { Signature }, // Proxy signature (digital or image) "sourceSignature" : { Signature } // Attester signature (digital or image) }, "validator" : [{ // Information about the entity validating information "organization" : { Reference(Organization) }, // R! Reference to the organization validating information "identityCertificate" : "<string>", // A digital identity certificate associated with the validator "attestationSignature" : { Signature } // Validator signature (digital or image) }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:VerificationResult; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:target ( [ Reference(Any) ] ... ) ; # 0..* A resource that was validated fhir:targetLocation ( [ string ] ... ) ; # 0..* The fhirpath location(s) within the resource that was validated fhir:need [ CodeableConcept ] ; # 0..1 none | initial | periodic fhir:status [ code ] ; # 1..1 attested | validated | in-process | req-revalid | val-fail | reval-fail | entered-in-error fhir:statusDate [ dateTime ] ; # 0..1 When the validation status was updated fhir:validationType [ CodeableConcept ] ; # 0..1 nothing | primary | multiple fhir:validationProcess ( [ CodeableConcept ] ... ) ; # 0..* The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context) fhir:frequency [ Timing ] ; # 0..1 Frequency of revalidation fhir:lastPerformed [ dateTime ] ; # 0..1 The date/time validation was last completed (including failed validations) fhir:nextScheduled [ date ] ; # 0..1 The date when target is next validated, if appropriate fhir:failureAction [ CodeableConcept ] ; # 0..1 fatal | warn | rec-only | none fhir:primarySource ( [ # 0..* Information about the primary source(s) involved in validation fhir:who [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 Reference to the primary source fhir:type ( [ CodeableConcept ] ... ) ; # 0..* Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source) fhir:communicationMethod ( [ CodeableConcept ] ... ) ; # 0..* Method for exchanging information with the primary source fhir:validationStatus [ CodeableConcept ] ; # 0..1 successful | failed | unknown fhir:validationDate [ dateTime ] ; # 0..1 When the target was validated against the primary source fhir:canPushUpdates [ CodeableConcept ] ; # 0..1 yes | no | undetermined fhir:pushTypeAvailable ( [ CodeableConcept ] ... ) ; # 0..* specific | any | source ] ... ) ; fhir:attestation [ # 0..1 Information about the entity attesting to information fhir:who [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 The individual or organization attesting to information fhir:onBehalfOf [ Reference(Organization|Practitioner|PractitionerRole) ] ; # 0..1 When the who is asserting on behalf of another (organization or individual) fhir:communicationMethod [ CodeableConcept ] ; # 0..1 The method by which attested information was submitted/retrieved fhir:date [ date ] ; # 0..1 The date the information was attested to fhir:sourceIdentityCertificate [ string ] ; # 0..1 A digital identity certificate associated with the attestation source fhir:proxyIdentityCertificate [ string ] ; # 0..1 A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source fhir:proxySignature [ Signature ] ; # 0..1 Proxy signature (digital or image) fhir:sourceSignature [ Signature ] ; # 0..1 Attester signature (digital or image) ] ; fhir:validator ( [ # 0..* Information about the entity validating information fhir:organization [ Reference(Organization) ] ; # 1..1 Reference to the organization validating information fhir:identityCertificate [ string ] ; # 0..1 A digital identity certificate associated with the validator fhir:attestationSignature [ Signature ] ; # 0..1 Validator signature (digital or image) ] ... ) ; ]
Changes from both R4 and R4B
VerificationResult | |
VerificationResult.status |
|
See the Full Difference for further information
This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.
Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis
Path | ValueSet | Type | Documentation |
---|---|---|---|
VerificationResult.need | Need | Preferred | The frequency with which the target must be validated |
VerificationResult.status | VerificationResultStatus (a valid code from status) | Required | The validation status of the target |
VerificationResult.validationType | ValidationType (a valid code from Validation-type ) | Preferred | What the target is validated against |
VerificationResult.validationProcess | ValidationProcess (a valid code from Validation-process ) | Example | The primary process by which the target is validated |
VerificationResult.failureAction | FailureAction (a valid code from Failure-action ) | Preferred | The result if validation fails |
VerificationResult.primarySource.type | PrimarySourceType (a valid code from Primary-source-type ) | Example | Type of the validation primary source |
VerificationResult.primarySource.communicationMethod | VerificationresultCommunicationMethod | Example | Attested information may be validated by process that are manual or automated. For automated processes it may accomplished by the system of record reaching out through another system's API or information may be sent to the system of record. This value set defines a set of codes to describing the process, the how, a resource or data element is validated. |
VerificationResult.primarySource.validationStatus | ValidationStatus (a valid code from Validation-status ) | Preferred | Status of the validation of the target against the primary source |
VerificationResult.primarySource.canPushUpdates | CanPushUpdates (a valid code from Can-push-updates ) | Preferred | Ability of the primary source to push updates/alerts |
VerificationResult.primarySource.pushTypeAvailable | PushTypeAvailable (a valid code from Push-type-available ) | Preferred | Type of alerts/updates the primary source can send |
VerificationResult.attestation.communicationMethod | VerificationresultCommunicationMethod | Example | Attested information may be validated by process that are manual or automated. For automated processes it may accomplished by the system of record reaching out through another system's API or information may be sent to the system of record. This value set defines a set of codes to describing the process, the how, a resource or data element is validated. |
Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
attestation-method | token | Select validation information for data that was attested to using the specified method | VerificationResult.attestation.communicationMethod | |
attestation-onbehalfof | reference | Select validation information for data that was attested to on behalf of the specified source | VerificationResult.attestation.onBehalfOf (Practitioner, Organization, PractitionerRole) | |
attestation-who | reference | Select validation information for data that was attested to by the specified source | VerificationResult.attestation.who (Practitioner, Organization, PractitionerRole) | |
primarysource-date | date | Select validation information for data that was validated against a primary source on the specified date | VerificationResult.primarySource.validationDate | |
primarysource-type | token | Select validation information for data that was validated against the specified type of primary source organization | VerificationResult.primarySource.type | |
primarysource-who | reference | Select validation information for data that was validated against the specified primary source | VerificationResult.primarySource.who (Practitioner, Organization, PractitionerRole) | |
status | token | Select validation information with the specified status | VerificationResult.status | |
status-date | date | Select validation information with a validation status that occurred at the specified date/time | VerificationResult.statusDate | |
target | reference | A resource that was validated | VerificationResult.target (Any) | |
validator-organization | reference | Select validation information for data that was validated by the specified organization | VerificationResult.validator.organization (Organization) |