Release 4 5 Snapshot #1

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). (v5.0.0-snapshot1: R5 Snapshot #1). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

8.32 8.33 Resource VerificationResult - Content

Patient Administration Work Group Maturity Level : 0   Trial Use Security Category : Business Compartments : Not linked to any defined compartments

Describes validation requirements, source(s), status and dates for one or more elements.

8.32.1 8.33.1 Scope and Usage

The VerificationResult can be used where content (such as found in a directory) is aggregated between systems, and the details of this process needs to be recorded, to be able to determine the likely accuracy of the content.

8.32.2 8.33.2 Boundaries and Relationships

TBD.

8.33.3 References

No resources refer to this resource directly.

This resource does not implement any patterns.

8.32.3 8.33.4 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . 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
Need need ( Preferred )
. . . statusDate Σ 0..1 dateTime When the validation status was updated
. . . validationType Σ 0..1 CodeableConcept nothing | primary | multiple
Validation-type 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)
Validation-process 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
Failure-action 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)
Primary-source-type primary-source-type ( Example )
. . . . communicationMethod Σ 0..* CodeableConcept Method for exchanging information with the primary source
VerificationResult Communication Method ( Example )
. . . . validationStatus 0..1 CodeableConcept successful | failed | unknown
Validation-status validation-status ( Preferred )
. . . . validationDate 0..1 dateTime When the target was validated against the primary source
. . . . canPushUpdates Σ 0..1 CodeableConcept yes | no | undetermined
Can-push-updates can-push-updates ( Preferred )
. . . . pushTypeAvailable 0..* CodeableConcept specific | any | source
Push-type-available 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
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
. . . . sourceSignature 0..1 Signature Attester signature
. . . 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

doco Documentation for this format

UML Diagram ( Legend )

VerificationResult ( DomainResource ) A resource that was validated target : Reference [0..*] « Any » The fhirpath location(s) within the resource that was validated targetLocation : string [0..*] The frequency with which the target must be validated (none; initial; periodic) need : CodeableConcept [0..1] « The frequency with which the target must be validated. null (Strength=Preferred) need ? » The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed) status : code [1..1] « The validation status of the target. null (Strength=Required) status ! » When the validation status was updated statusDate : dateTime [0..1] What the target is validated against (nothing; primary source; multiple sources) validationType : CodeableConcept [0..1] « What the target is validated against. null (Strength=Preferred) validation-type ? » The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context) validationProcess : CodeableConcept [0..*] « The primary process by which the target is validated. null (Strength=Example) validation-process ?? » Frequency of revalidation frequency : Timing [0..1] The date/time validation was last completed (including failed validations) lastPerformed : dateTime [0..1] The date when target is next validated, if appropriate nextScheduled : date [0..1] The result if validation fails (fatal; warning; record only; none) failureAction : CodeableConcept [0..1] « The result if validation fails. null (Strength=Preferred) failure-action ? » PrimarySource Reference to the primary source who : Reference [0..1] « Organization | Practitioner | PractitionerRole » Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source) type : CodeableConcept [0..*] « Type of the validation primary source. null (Strength=Example) primary-source-type ?? » Method for communicating with the primary source (manual; API; Push) communicationMethod : CodeableConcept [0..*] « Method for communicating with the data source (manual; API; Push). null (Strength=Example) verificationresult-communicat... ?? » Status of the validation of the target against the primary source (successful; failed; unknown) validationStatus : CodeableConcept [0..1] « Status of the validation of the target against the primary source. null (Strength=Preferred) validation-status ? » When the target was validated against the primary source validationDate : dateTime [0..1] Ability of the primary source to push updates/alerts (yes; no; undetermined) canPushUpdates : CodeableConcept [0..1] « Ability of the primary source to push updates/alerts. null (Strength=Preferred) can-push-updates ? » Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source) pushTypeAvailable : CodeableConcept [0..*] « Type of alerts/updates the primary source can send. null (Strength=Preferred) push-type-available ? » Attestation The individual or organization attesting to information who : Reference [0..1] « Practitioner | PractitionerRole | Organization » When the who is asserting on behalf of another (organization or individual) onBehalfOf : Reference [0..1] « Organization | Practitioner | PractitionerRole » The method by which attested information was submitted/retrieved (manual; API; Push) communicationMethod : CodeableConcept [0..1] « Method for communicating with the data source (manual; API; Push). null (Strength=Example) verificationresult-communicat... ?? » The date the information was attested to date : date [0..1] A digital identity certificate associated with the attestation source sourceIdentityCertificate : string [0..1] A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source proxyIdentityCertificate : string [0..1] Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source proxySignature : Signature [0..1] Signed assertion by the attestation source that they have attested to the information sourceSignature : Signature [0..1] Validator Reference to the organization validating information organization : Reference [1..1] « Organization » A digital identity certificate associated with the validator identityCertificate : string [0..1] Signed assertion by the validator that they have validated the information attestationSignature : Signature [0..1] Information about the primary source(s) involved in validation primarySource [0..*] Information about the entity attesting to information attestation [0..1] Information about the entity validating information validator [0..*]

XML Template 

<VerificationResult xmlns="http://hl7.org/fhir"> doco
 <!-- 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 -->
 <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>

  <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 --></proxySignature>
  <sourceSignature><!-- 0..1 Signature Attester signature --></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 --></attestationSignature>
 </validator>
</VerificationResult>

JSON Template 

{doco
  "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
  "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
    "sourceSignature" : { Signature } // Attester signature
  },
  "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
  }]
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ 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:VerificationResult.target [ Reference(Any) ], ... ; # 0..* A resource that was validated
  fhir:VerificationResult.targetLocation [ string ], ... ; # 0..* The fhirpath location(s) within the resource that was validated
  fhir:VerificationResult.need [ CodeableConcept ]; # 0..1 none | initial | periodic
  fhir:VerificationResult.status [ code ]; # 1..1 attested | validated | in-process | req-revalid | val-fail | reval-fail
  fhir:VerificationResult.statusDate [ dateTime ]; # 0..1 When the validation status was updated
  fhir:VerificationResult.validationType [ CodeableConcept ]; # 0..1 nothing | primary | multiple
  fhir:VerificationResult.validationProcess [ CodeableConcept ], ... ; # 0..* The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context)
  fhir:VerificationResult.frequency [ Timing ]; # 0..1 Frequency of revalidation
  fhir:VerificationResult.lastPerformed [ dateTime ]; # 0..1 The date/time validation was last completed (including failed validations)
  fhir:VerificationResult.nextScheduled [ date ]; # 0..1 The date when target is next validated, if appropriate
  fhir:VerificationResult.failureAction [ CodeableConcept ]; # 0..1 fatal | warn | rec-only | none
  fhir:VerificationResult.primarySource [ # 0..* Information about the primary source(s) involved in validation
    fhir:VerificationResult.primarySource.who [ Reference(Organization|Practitioner|PractitionerRole) ]; # 0..1 Reference to the primary source
    fhir:VerificationResult.primarySource.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:VerificationResult.primarySource.communicationMethod [ CodeableConcept ], ... ; # 0..* Method for exchanging information with the primary source
    fhir:VerificationResult.primarySource.validationStatus [ CodeableConcept ]; # 0..1 successful | failed | unknown
    fhir:VerificationResult.primarySource.validationDate [ dateTime ]; # 0..1 When the target was validated against the primary source
    fhir:VerificationResult.primarySource.canPushUpdates [ CodeableConcept ]; # 0..1 yes | no | undetermined
    fhir:VerificationResult.primarySource.pushTypeAvailable [ CodeableConcept ], ... ; # 0..* specific | any | source
  ], ...;
  fhir:VerificationResult.attestation [ # 0..1 Information about the entity attesting to information
    fhir:

    fhir:VerificationResult.attestation.who [ Reference(Organization|Practitioner|PractitionerRole) ]; # 0..1 The individual or organization attesting to information

    fhir:VerificationResult.attestation.onBehalfOf [ Reference(Organization|Practitioner|PractitionerRole) ]; # 0..1 When the who is asserting on behalf of another (organization or individual)
    fhir:VerificationResult.attestation.communicationMethod [ CodeableConcept ]; # 0..1 The method by which attested information was submitted/retrieved
    fhir:VerificationResult.attestation.date [ date ]; # 0..1 The date the information was attested to
    fhir:VerificationResult.attestation.sourceIdentityCertificate [ string ]; # 0..1 A digital identity certificate associated with the attestation source
    fhir:VerificationResult.attestation.proxyIdentityCertificate [ string ]; # 0..1 A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
    fhir:VerificationResult.attestation.proxySignature [ Signature ]; # 0..1 Proxy signature
    fhir:VerificationResult.attestation.sourceSignature [ Signature ]; # 0..1 Attester signature
  ];
  fhir:VerificationResult.validator [ # 0..* Information about the entity validating information
    fhir:VerificationResult.validator.organization [ Reference(Organization) ]; # 1..1 Reference to the organization validating information
    fhir:VerificationResult.validator.identityCertificate [ string ]; # 0..1 A digital identity certificate associated with the validator
    fhir:VerificationResult.validator.attestationSignature [ Signature ]; # 0..1 Validator signature
  ], ...;
]

Changes since R3

VerificationResult
VerificationResult.status
  • Change value set from http://hl7.org/fhir/ValueSet/verificationresult-status|4.0.0 to http://hl7.org/fhir/ValueSet/verificationresult-status|5.0.0-snapshot1

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

Structure

Name Flags Card. Type Description & Constraints doco
. . 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
Need need ( Preferred )
. . . statusDate Σ 0..1 dateTime When the validation status was updated
. . . validationType Σ 0..1 CodeableConcept nothing | primary | multiple
Validation-type 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)
Validation-process 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
Failure-action 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)
Primary-source-type primary-source-type ( Example )
. . . . communicationMethod Σ 0..* CodeableConcept Method for exchanging information with the primary source
VerificationResult Communication Method ( Example )
. . . . validationStatus 0..1 CodeableConcept successful | failed | unknown
Validation-status validation-status ( Preferred )
. . . . validationDate 0..1 dateTime When the target was validated against the primary source
. . . . canPushUpdates Σ 0..1 CodeableConcept yes | no | undetermined
Can-push-updates can-push-updates ( Preferred )
. . . . pushTypeAvailable 0..* CodeableConcept specific | any | source
Push-type-available 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
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
. . . . sourceSignature 0..1 Signature Attester signature
. . . 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

doco Documentation for this format

UML Diagram ( Legend )

VerificationResult ( DomainResource ) A resource that was validated target : Reference [0..*] « Any » The fhirpath location(s) within the resource that was validated targetLocation : string [0..*] The frequency with which the target must be validated (none; initial; periodic) need : CodeableConcept [0..1] « The frequency with which the target must be validated. null (Strength=Preferred) need ? » The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed) status : code [1..1] « The validation status of the target. null (Strength=Required) status ! » When the validation status was updated statusDate : dateTime [0..1] What the target is validated against (nothing; primary source; multiple sources) validationType : CodeableConcept [0..1] « What the target is validated against. null (Strength=Preferred) validation-type ? » The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context) validationProcess : CodeableConcept [0..*] « The primary process by which the target is validated. null (Strength=Example) validation-process ?? » Frequency of revalidation frequency : Timing [0..1] The date/time validation was last completed (including failed validations) lastPerformed : dateTime [0..1] The date when target is next validated, if appropriate nextScheduled : date [0..1] The result if validation fails (fatal; warning; record only; none) failureAction : CodeableConcept [0..1] « The result if validation fails. null (Strength=Preferred) failure-action ? » PrimarySource Reference to the primary source who : Reference [0..1] « Organization | Practitioner | PractitionerRole » Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source) type : CodeableConcept [0..*] « Type of the validation primary source. null (Strength=Example) primary-source-type ?? » Method for communicating with the primary source (manual; API; Push) communicationMethod : CodeableConcept [0..*] « Method for communicating with the data source (manual; API; Push). null (Strength=Example) verificationresult-communicat... ?? » Status of the validation of the target against the primary source (successful; failed; unknown) validationStatus : CodeableConcept [0..1] « Status of the validation of the target against the primary source. null (Strength=Preferred) validation-status ? » When the target was validated against the primary source validationDate : dateTime [0..1] Ability of the primary source to push updates/alerts (yes; no; undetermined) canPushUpdates : CodeableConcept [0..1] « Ability of the primary source to push updates/alerts. null (Strength=Preferred) can-push-updates ? » Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source) pushTypeAvailable : CodeableConcept [0..*] « Type of alerts/updates the primary source can send. null (Strength=Preferred) push-type-available ? » Attestation The individual or organization attesting to information who : Reference [0..1] « Practitioner | PractitionerRole | Organization » When the who is asserting on behalf of another (organization or individual) onBehalfOf : Reference [0..1] « Organization | Practitioner | PractitionerRole » The method by which attested information was submitted/retrieved (manual; API; Push) communicationMethod : CodeableConcept [0..1] « Method for communicating with the data source (manual; API; Push). null (Strength=Example) verificationresult-communicat... ?? » The date the information was attested to date : date [0..1] A digital identity certificate associated with the attestation source sourceIdentityCertificate : string [0..1] A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source proxyIdentityCertificate : string [0..1] Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source proxySignature : Signature [0..1] Signed assertion by the attestation source that they have attested to the information sourceSignature : Signature [0..1] Validator Reference to the organization validating information organization : Reference [1..1] « Organization » A digital identity certificate associated with the validator identityCertificate : string [0..1] Signed assertion by the validator that they have validated the information attestationSignature : Signature [0..1] Information about the primary source(s) involved in validation primarySource [0..*] Information about the entity attesting to information attestation [0..1] Information about the entity validating information validator [0..*]

XML Template 

<VerificationResult xmlns="http://hl7.org/fhir"> doco
 <!-- 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 -->
 <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>

  <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 --></proxySignature>
  <sourceSignature><!-- 0..1 Signature Attester signature --></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 --></attestationSignature>
 </validator>
</VerificationResult>

JSON Template 

{doco
  "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
  "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
    "sourceSignature" : { Signature } // Attester signature
  },
  "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
  }]
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ 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:VerificationResult.target [ Reference(Any) ], ... ; # 0..* A resource that was validated
  fhir:VerificationResult.targetLocation [ string ], ... ; # 0..* The fhirpath location(s) within the resource that was validated
  fhir:VerificationResult.need [ CodeableConcept ]; # 0..1 none | initial | periodic
  fhir:VerificationResult.status [ code ]; # 1..1 attested | validated | in-process | req-revalid | val-fail | reval-fail
  fhir:VerificationResult.statusDate [ dateTime ]; # 0..1 When the validation status was updated
  fhir:VerificationResult.validationType [ CodeableConcept ]; # 0..1 nothing | primary | multiple
  fhir:VerificationResult.validationProcess [ CodeableConcept ], ... ; # 0..* The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context)
  fhir:VerificationResult.frequency [ Timing ]; # 0..1 Frequency of revalidation
  fhir:VerificationResult.lastPerformed [ dateTime ]; # 0..1 The date/time validation was last completed (including failed validations)
  fhir:VerificationResult.nextScheduled [ date ]; # 0..1 The date when target is next validated, if appropriate
  fhir:VerificationResult.failureAction [ CodeableConcept ]; # 0..1 fatal | warn | rec-only | none
  fhir:VerificationResult.primarySource [ # 0..* Information about the primary source(s) involved in validation
    fhir:VerificationResult.primarySource.who [ Reference(Organization|Practitioner|PractitionerRole) ]; # 0..1 Reference to the primary source
    fhir:VerificationResult.primarySource.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:VerificationResult.primarySource.communicationMethod [ CodeableConcept ], ... ; # 0..* Method for exchanging information with the primary source
    fhir:VerificationResult.primarySource.validationStatus [ CodeableConcept ]; # 0..1 successful | failed | unknown
    fhir:VerificationResult.primarySource.validationDate [ dateTime ]; # 0..1 When the target was validated against the primary source
    fhir:VerificationResult.primarySource.canPushUpdates [ CodeableConcept ]; # 0..1 yes | no | undetermined
    fhir:VerificationResult.primarySource.pushTypeAvailable [ CodeableConcept ], ... ; # 0..* specific | any | source
  ], ...;
  fhir:VerificationResult.attestation [ # 0..1 Information about the entity attesting to information
    fhir:

    fhir:VerificationResult.attestation.who [ Reference(Organization|Practitioner|PractitionerRole) ]; # 0..1 The individual or organization attesting to information

    fhir:VerificationResult.attestation.onBehalfOf [ Reference(Organization|Practitioner|PractitionerRole) ]; # 0..1 When the who is asserting on behalf of another (organization or individual)
    fhir:VerificationResult.attestation.communicationMethod [ CodeableConcept ]; # 0..1 The method by which attested information was submitted/retrieved
    fhir:VerificationResult.attestation.date [ date ]; # 0..1 The date the information was attested to
    fhir:VerificationResult.attestation.sourceIdentityCertificate [ string ]; # 0..1 A digital identity certificate associated with the attestation source
    fhir:VerificationResult.attestation.proxyIdentityCertificate [ string ]; # 0..1 A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
    fhir:VerificationResult.attestation.proxySignature [ Signature ]; # 0..1 Proxy signature
    fhir:VerificationResult.attestation.sourceSignature [ Signature ]; # 0..1 Attester signature
  ];
  fhir:VerificationResult.validator [ # 0..* Information about the entity validating information
    fhir:VerificationResult.validator.organization [ Reference(Organization) ]; # 1..1 Reference to the organization validating information
    fhir:VerificationResult.validator.identityCertificate [ string ]; # 0..1 A digital identity certificate associated with the validator
    fhir:VerificationResult.validator.attestationSignature [ Signature ]; # 0..1 Validator signature
  ], ...;
]

Changes since Release 3

VerificationResult
VerificationResult.status
  • Change value set from http://hl7.org/fhir/ValueSet/verificationresult-status|4.0.0 to http://hl7.org/fhir/ValueSet/verificationresult-status|5.0.0-snapshot1

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis a

8.32.3.1 8.33.4.1 Terminology Bindings

Path Definition Type Reference
VerificationResult.need The frequency with which the target must be validated. Preferred need
VerificationResult.status The validation status of the target. Required status
VerificationResult.validationType What the target is validated against. Preferred validation-type
VerificationResult.validationProcess The primary process by which the target is validated. Example validation-process
VerificationResult.failureAction The result if validation fails. Preferred failure-action
VerificationResult.primarySource.type Type of the validation primary source. Example primary-source-type
VerificationResult.primarySource.communicationMethod VerificationResult.attestation.communicationMethod Method for communicating with the data source (manual; API; Push). Example verificationresult-communication-method
VerificationResult.primarySource.validationStatus Status of the validation of the target against the primary source. Preferred validation-status
VerificationResult.primarySource.canPushUpdates Ability of the primary source to push updates/alerts. Preferred can-push-updates
VerificationResult.primarySource.pushTypeAvailable Type of alerts/updates the primary source can send. Preferred push-type-available
VerificationResult.attestation.communicationMethod Example verificationresult-communication-method

8.32.4 8.33.5 Notes:

8.32.5 8.33.6 Search Parameters

Search parameters for 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
target reference A resource that was validated VerificationResult.target
(Any)