R4 Ballot #1 #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: (v3.5.0: R4 Ballot 2). #2). 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.35 Resource VerificationResult - Content

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

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

8.35.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.35.2 Boundaries and Relationships

TBD.

8.35.3 Resource Content

Structure

Identifier
Name Flags Card. Type Description & Constraints doco
. . VerificationResult D 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 Σ 1..1 0..1 code CodeableConcept none | initial | periodic
need Need ( Required Preferred )
. . . status Σ 1..1 code attested | validated | in-process | req-revalid | val-fail | reval-fail
status Status ( Required )
. . . statusDate Σ 1..1 0..1 dateTime When the validation status was updated
. . . validationType Σ 1..1 0..1 code CodeableConcept nothing | primary | multiple
validation-type Validation-type ( Required Preferred )
. . . validationProcess Σ 1..* 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 (incl. failed validations)
. . . nextScheduled 0..1 date The date when target is next validated, if appropriate
. . . failureAction Σ 1..1 0..1 code CodeableConcept fatal | warn | rec-only | none
failure-action Failure-action ( Required Preferred )
. . . primarySource 0..* BackboneElement Information about the primary source(s) involved in validation
. . . identifier 0..1 Identifier URI of the primary source for validation . organization 0..1 Reference ( Organization ) Reference to the primary source
. . . . type Σ 1..* 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 )
. . . . validationProcess Σ 1..* 0..* CodeableConcept Method for communicating with The process(es) by which the primary source (manual; API; Push) target is validated
. . . . validationStatus 0..1 code CodeableConcept successful | failed | unknown
validation-status Validation-status ( Required Preferred )
. . . . validationDate 0..1 dateTime When the target was validated against the primary source
. . . . canPushUpdates Σ 1..1 0..1 code CodeableConcept yes | no | undetermined
can-push-updates Can-push-updates ( Required Preferred )
. . . . pushTypeAvailable 0..* code CodeableConcept specific | any | source
push-type-available Push-type-available ( Required Preferred )
. . . attestation 0..1 BackboneElement Information about the entity attesting to information
. . . . source Σ 1..1 0..1 Reference ( Practitioner ) The individual attesting to information
. . . . organization Σ 1..1 0..1 Reference ( Organization ) The organization attesting to information
. . . . method Σ 1..1 0..1 CodeableConcept Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source)
. . . . date Σ 1..1 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
. . validator . . signedProxyRight[x] 0..* 0..1 BackboneElement Proxy signature
..... signedProxyRightString string Information about the entity validating information
. . . . . signedProxyRightUri uri
. . . . signedSourceAttestation[x] 0..1 Attester signature
.. . . identifier . signedSourceAttestationString string
. . . . . signedSourceAttestationUri uri
. . . validator 0..1 0..* BackboneElement URI of Information about the validator 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
. . . dateValidated . signedValidatorAttestation[x] 1..1 0..1 date Validator signature
..... signedValidatorAttestationString string Date on which the validator last validated the information
. . . . . signedValidatorAttestationUri uri

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 : code CodeableConcept [1..1] [0..1] « The frequency with which the target must be validated (Strength=Required) validated. (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 target. (Strength=Required) status ! » When the validation status was updated statusDate : dateTime [1..1] [0..1] What the target is validated against (nothing; primary source; multiple sources) validationType : code CodeableConcept [1..1] [0..1] « What the target is validated against (Strength=Required) against. (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 [1..*] [0..*] « The primary process by which the target is validated validated. (Strength=Example) validation-process ?? » Frequency of revalidation frequency : Timing [0..1] The date/time validation was last completed (incl. 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 : code CodeableConcept [1..1] [0..1] « The result if validation fails (Strength=Required) fails. (Strength=Preferred) failure-action ! ? » PrimarySource URI of the primary source for validation identifier : Identifier [0..1] Reference to the primary source organization : Reference [0..1] « Organization » Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source) type : CodeableConcept [1..*] [0..*] « Type of the validation primary source source. (Strength=Example) primary-source-type ?? » Method for communicating with the primary source (manual; API; Push) validationProcess : CodeableConcept [1..*] [0..*] Status of the validation of the target against the primary source (successful; failed; unknown) validationStatus : code CodeableConcept [0..1] « Status of the validation of the target against the primary source (Strength=Required) source. (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 : code CodeableConcept [1..1] [0..1] « Ability of the primary source to push updates/alerts (Strength=Required) updates/alerts. (Strength=Preferred) can-push-updates ! ? » Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source) pushTypeAvailable : code CodeableConcept [0..*] « Type of alerts/updates the primary source can send (Strength=Required) send. (Strength=Preferred) push-type-available ! ? » Attestation The individual attesting to information source : Reference [1..1] [0..1] « Practitioner » The organization attesting to information organization : Reference [1..1] [0..1] « Organization » Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source) method : CodeableConcept [1..1] [0..1] The date the information was attested to date : date [1..1] [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] Validator Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source signedProxyRight[x] : Type [0..1] « string | uri » URI of Signed assertion by the validator attestation source that they have attested to the information identifier signedSourceAttestation[x] : Identifier Type [0..1] « string | uri » Validator Reference to the organization validating information organization : Reference [1..1] « Organization » A digital identity certificate associated with the validator identityCertificate : string [0..1] Date on which Signed assertion by the validator last that they have validated the information dateValidated signedValidatorAttestation[x] : date Type [1..1] [0..1] « string | uri » 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 -->
 <
 <
 <
 <
 <</validationProcess>

 <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 (incl. 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 -->
  <</identifier>

  <organization><!-- 0..1 Reference(Organization) Reference to the primary source --></organization>
  <</type>
  <</validationProcess>
  <

  <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>
  <validationProcess><!-- 0..* CodeableConcept The process(es) by which the target is validated --></validationProcess>
  <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 -->
  <</source>
  <</organization>
  <</method>
  <

  <source><!-- 0..1 Reference(Practitioner) The individual attesting to information --></source>
  <organization><!-- 0..1 Reference(Organization) The organization attesting to information --></organization>
  <method><!-- 0..1 CodeableConcept Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source) --></method>
  <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 -->
  <signedProxyRight[x]><!-- 0..1 string|uri Proxy signature --></signedProxyRight[x]>
  <signedSourceAttestation[x]><!-- 0..1 string|uri Attester signature --></signedSourceAttestation[x]>

 </attestation>
 <validator>  <!-- 0..* Information about the entity validating information -->
  <</identifier>

  <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 -->
  <

  <signedValidatorAttestation[x]><!-- 0..1 string|uri Validator signature --></signedValidatorAttestation[x]>

 </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 (incl. 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
    "

    "organization" : { Reference(Organization) }, // 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)
    "validationProcess" : [{ CodeableConcept }], // The process(es) by which the target is validated
    "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
    "
    "
    "
    "

    "source" : { Reference(Practitioner) }, // The individual attesting to information
    "organization" : { Reference(Organization) }, // The organization attesting to information
    "method" : { CodeableConcept }, // Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source)
    "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
    // signedProxyRight[x]: Proxy signature. One of these 2:

    "signedProxyRightString" : "<string>",
    "signedProxyRightUri" : "<uri>",
    // signedSourceAttestation[x]: Attester signature. One of these 2:

    "signedSourceAttestationString" : "<string>"
    "signedSourceAttestationUri" : "<uri>"

  },
  "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
    "

    // signedValidatorAttestation[x]: Validator signature. One of these 2:
    "signedValidatorAttestationString" : "<string>"
    "signedValidatorAttestationUri" : "<uri>"

  }]
}

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:

  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:
  fhir:
  fhir:

  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 (incl. failed validations)
  fhir:VerificationResult.nextScheduled [ date ]; # 0..1 The date when target is next validated, if appropriate
  fhir:

  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:

    fhir:VerificationResult.primarySource.organization [ Reference(Organization) ]; # 0..1 Reference to the primary source
    fhir:
    fhir:
    fhir:

    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.validationProcess [ CodeableConcept ], ... ; # 0..* The process(es) by which the target is validated
    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:
    fhir:

    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:
    fhir:
    fhir:

    fhir:VerificationResult.attestation.source [ Reference(Practitioner) ]; # 0..1 The individual attesting to information
    fhir:VerificationResult.attestation.organization [ Reference(Organization) ]; # 0..1 The organization attesting to information
    fhir:VerificationResult.attestation.method [ CodeableConcept ]; # 0..1 Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source)
    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
    # VerificationResult.attestation.signedProxyRight[x] : 0..1 Proxy signature. One of these 2
      fhir:VerificationResult.attestation.signedProxyRightString [ string ]
      fhir:VerificationResult.attestation.signedProxyRightUri [ uri ]
    # VerificationResult.attestation.signedSourceAttestation[x] : 0..1 Attester signature. One of these 2
      fhir:VerificationResult.attestation.signedSourceAttestationString [ string ]
      fhir:VerificationResult.attestation.signedSourceAttestationUri [ uri ]

  ];
  fhir:VerificationResult.validator [ # 0..* Information about the entity validating information
    fhir:

    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.signedValidatorAttestation[x] : 0..1 Validator signature. One of these 2
      fhir:VerificationResult.validator.signedValidatorAttestationString [ string ]
      fhir:VerificationResult.validator.signedValidatorAttestationUri [ uri ]

  ], ...;
]

Changes since R3

This resource did not exist in Release 2

This analysis is available as XML or JSON .

See R3 <--> R4 Conversion Maps (status = Not Mapped)

Structure

Identifier
Name Flags Card. Type Description & Constraints doco
. . VerificationResult D 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 Σ 1..1 0..1 code CodeableConcept none | initial | periodic
need Need ( Required Preferred )
. . . status Σ 1..1 code attested | validated | in-process | req-revalid | val-fail | reval-fail
status Status ( Required )
. . . statusDate Σ 1..1 0..1 dateTime When the validation status was updated
. . . validationType Σ 1..1 0..1 code CodeableConcept nothing | primary | multiple
validation-type Validation-type ( Required Preferred )
. . . validationProcess Σ 1..* 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 (incl. failed validations)
. . . nextScheduled 0..1 date The date when target is next validated, if appropriate
. . . failureAction Σ 1..1 0..1 code CodeableConcept fatal | warn | rec-only | none
failure-action Failure-action ( Required Preferred )
. . . primarySource 0..* BackboneElement Information about the primary source(s) involved in validation
. . . identifier 0..1 Identifier URI of the primary source for validation . organization 0..1 Reference ( Organization ) Reference to the primary source
. . . . type Σ 1..* 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 )
. . . . validationProcess Σ 1..* 0..* CodeableConcept Method for communicating with The process(es) by which the primary source (manual; API; Push) target is validated
. . . . validationStatus 0..1 code CodeableConcept successful | failed | unknown
validation-status Validation-status ( Required Preferred )
. . . . validationDate 0..1 dateTime When the target was validated against the primary source
. . . . canPushUpdates Σ 1..1 0..1 code CodeableConcept yes | no | undetermined
can-push-updates Can-push-updates ( Required Preferred )
. . . . pushTypeAvailable 0..* code CodeableConcept specific | any | source
push-type-available Push-type-available ( Required Preferred )
. . . attestation 0..1 BackboneElement Information about the entity attesting to information
. . . . source Σ 1..1 0..1 Reference ( Practitioner ) The individual attesting to information
. . . . organization Σ 1..1 0..1 Reference ( Organization ) The organization attesting to information
. . . . method Σ 1..1 0..1 CodeableConcept Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source)
. . . . date Σ 1..1 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
. . validator . . signedProxyRight[x] 0..* 0..1 BackboneElement Proxy signature
..... signedProxyRightString string Information about the entity validating information
. . . . . signedProxyRightUri uri
.... signedSourceAttestation[x] 0..1 Attester signature
.. . . identifier . signedSourceAttestationString string
. . . . . signedSourceAttestationUri uri
. . . validator 0..1 0..* BackboneElement URI of Information about the validator 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
. . . dateValidated . signedValidatorAttestation[x] 1..1 0..1 date Validator signature
..... signedValidatorAttestationString string Date on which the validator last validated the information
. . . . . signedValidatorAttestationUri uri

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 : code CodeableConcept [1..1] [0..1] « The frequency with which the target must be validated (Strength=Required) validated. (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 target. (Strength=Required) status ! » When the validation status was updated statusDate : dateTime [1..1] [0..1] What the target is validated against (nothing; primary source; multiple sources) validationType : code CodeableConcept [1..1] [0..1] « What the target is validated against (Strength=Required) against. (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 [1..*] [0..*] « The primary process by which the target is validated validated. (Strength=Example) validation-process ?? » Frequency of revalidation frequency : Timing [0..1] The date/time validation was last completed (incl. 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 : code CodeableConcept [1..1] [0..1] « The result if validation fails (Strength=Required) fails. (Strength=Preferred) failure-action ! ? » PrimarySource URI of the primary source for validation identifier : Identifier [0..1] Reference to the primary source organization : Reference [0..1] « Organization » Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source) type : CodeableConcept [1..*] [0..*] « Type of the validation primary source source. (Strength=Example) primary-source-type ?? » Method for communicating with the primary source (manual; API; Push) validationProcess : CodeableConcept [1..*] [0..*] Status of the validation of the target against the primary source (successful; failed; unknown) validationStatus : code CodeableConcept [0..1] « Status of the validation of the target against the primary source (Strength=Required) source. (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 : code CodeableConcept [1..1] [0..1] « Ability of the primary source to push updates/alerts (Strength=Required) updates/alerts. (Strength=Preferred) can-push-updates ! ? » Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source) pushTypeAvailable : code CodeableConcept [0..*] « Type of alerts/updates the primary source can send (Strength=Required) send. (Strength=Preferred) push-type-available ! ? » Attestation The individual attesting to information source : Reference [1..1] [0..1] « Practitioner » The organization attesting to information organization : Reference [1..1] [0..1] « Organization » Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source) method : CodeableConcept [1..1] [0..1] The date the information was attested to date : date [1..1] [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] Validator Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source signedProxyRight[x] : Type [0..1] « string | uri » URI of Signed assertion by the validator attestation source that they have attested to the information identifier signedSourceAttestation[x] : Identifier Type [0..1] « string | uri » Validator Reference to the organization validating information organization : Reference [1..1] « Organization » A digital identity certificate associated with the validator identityCertificate : string [0..1] Date on which Signed assertion by the validator last that they have validated the information dateValidated signedValidatorAttestation[x] : date Type [1..1] [0..1] « string | uri » 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 -->
 <
 <
 <
 <
 <</validationProcess>

 <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 (incl. 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 -->
  <</identifier>

  <organization><!-- 0..1 Reference(Organization) Reference to the primary source --></organization>
  <</type>
  <</validationProcess>
  <

  <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>
  <validationProcess><!-- 0..* CodeableConcept The process(es) by which the target is validated --></validationProcess>
  <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 -->
  <</source>
  <</organization>
  <</method>
  <

  <source><!-- 0..1 Reference(Practitioner) The individual attesting to information --></source>
  <organization><!-- 0..1 Reference(Organization) The organization attesting to information --></organization>
  <method><!-- 0..1 CodeableConcept Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source) --></method>
  <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 -->
  <signedProxyRight[x]><!-- 0..1 string|uri Proxy signature --></signedProxyRight[x]>
  <signedSourceAttestation[x]><!-- 0..1 string|uri Attester signature --></signedSourceAttestation[x]>

 </attestation>
 <validator>  <!-- 0..* Information about the entity validating information -->
  <</identifier>

  <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 -->
  <

  <signedValidatorAttestation[x]><!-- 0..1 string|uri Validator signature --></signedValidatorAttestation[x]>

 </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 (incl. 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
    "

    "organization" : { Reference(Organization) }, // 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)
    "validationProcess" : [{ CodeableConcept }], // The process(es) by which the target is validated
    "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
    "
    "
    "
    "

    "source" : { Reference(Practitioner) }, // The individual attesting to information
    "organization" : { Reference(Organization) }, // The organization attesting to information
    "method" : { CodeableConcept }, // Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source)
    "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
    // signedProxyRight[x]: Proxy signature. One of these 2:

    "signedProxyRightString" : "<string>",
    "signedProxyRightUri" : "<uri>",
    // signedSourceAttestation[x]: Attester signature. One of these 2:

    "signedSourceAttestationString" : "<string>"
    "signedSourceAttestationUri" : "<uri>"

  },
  "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
    "

    // signedValidatorAttestation[x]: Validator signature. One of these 2:
    "signedValidatorAttestationString" : "<string>"
    "signedValidatorAttestationUri" : "<uri>"

  }]
}

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:

  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:
  fhir:
  fhir:

  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 (incl. failed validations)
  fhir:VerificationResult.nextScheduled [ date ]; # 0..1 The date when target is next validated, if appropriate
  fhir:

  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:

    fhir:VerificationResult.primarySource.organization [ Reference(Organization) ]; # 0..1 Reference to the primary source
    fhir:
    fhir:
    fhir:

    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.validationProcess [ CodeableConcept ], ... ; # 0..* The process(es) by which the target is validated
    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:
    fhir:

    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:
    fhir:
    fhir:

    fhir:VerificationResult.attestation.source [ Reference(Practitioner) ]; # 0..1 The individual attesting to information
    fhir:VerificationResult.attestation.organization [ Reference(Organization) ]; # 0..1 The organization attesting to information
    fhir:VerificationResult.attestation.method [ CodeableConcept ]; # 0..1 Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source)
    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
    # VerificationResult.attestation.signedProxyRight[x] : 0..1 Proxy signature. One of these 2
      fhir:VerificationResult.attestation.signedProxyRightString [ string ]
      fhir:VerificationResult.attestation.signedProxyRightUri [ uri ]
    # VerificationResult.attestation.signedSourceAttestation[x] : 0..1 Attester signature. One of these 2
      fhir:VerificationResult.attestation.signedSourceAttestationString [ string ]
      fhir:VerificationResult.attestation.signedSourceAttestationUri [ uri ]

  ];
  fhir:VerificationResult.validator [ # 0..* Information about the entity validating information
    fhir:

    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.signedValidatorAttestation[x] : 0..1 Validator signature. One of these 2
      fhir:VerificationResult.validator.signedValidatorAttestationString [ string ]
      fhir:VerificationResult.validator.signedValidatorAttestationUri [ uri ]

  ], ...;
]

Changes since DSTU2 Release 3

This resource did not exist in Release 2

This analysis is available as XML or JSON .

See R3 <--> R4 Conversion Maps (status = Not Mapped)

 

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

8.35.3.1 Terminology Bindings

Path Definition Type Reference
VerificationResult.need The frequency with which the target must be validated validated. Required Preferred need
VerificationResult.status The validation status of the target target. Required status
VerificationResult.validationType What the target is validated against against. Required Preferred validation-type
VerificationResult.validationProcess The primary process by which the target is validated validated. Example validation-process
VerificationResult.failureAction The result if validation fails fails. Required Preferred failure-action
VerificationResult.primarySource.type Type of the validation primary source source. Example primary-source-type
VerificationResult.primarySource.validationStatus Status of the validation of the target against the primary source source. Required Preferred validation-status
VerificationResult.primarySource.canPushUpdates Ability of the primary source to push updates/alerts updates/alerts. Required Preferred can-push-updates
VerificationResult.primarySource.pushTypeAvailable Type of alerts/updates the primary source can send send. Required Preferred push-type-available

8.35.4 Notes:

8.35.5 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)