Current Build

8.36 Resource VerificationResult - Content

Patient Administration Work GroupMaturity Level: 0 Draft Compartments: Not linked to any defined compartments

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

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

TBD.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult DDomainResourceDescribes 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..*stringThe fhirpath location(s) within the resource that was validated
... need Σ0..1CodeableConceptnone | initial | periodic
need (Preferred)
... status Σ1..1codeattested | validated | in-process | req-revalid | val-fail | reval-fail
status (Required)
... statusDate Σ0..1dateTimeWhen the validation status was updated
... validationType Σ0..1CodeableConceptnothing | primary | multiple
validation-type (Preferred)
... validationProcess Σ0..*CodeableConceptThe primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context)
validation-process (Example)
... frequency 0..1TimingFrequency of revalidation
... lastPerformed 0..1dateTimeThe date/time validation was last completed (incl. failed validations)
... nextScheduled 0..1dateThe date when target is next validated, if appropriate
... failureAction Σ0..1CodeableConceptfatal | warn | rec-only | none
failure-action (Preferred)
... primarySource 0..*BackboneElementInformation about the primary source(s) involved in validation
.... organization 0..1Reference(Organization)Reference to the primary source
.... type Σ0..*CodeableConceptType of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source)
primary-source-type (Example)
.... validationProcess Σ0..*CodeableConceptThe process(es) by which the target is validated
.... validationStatus 0..1CodeableConceptsuccessful | failed | unknown
validation-status (Preferred)
.... validationDate 0..1dateTimeWhen the target was validated against the primary source
.... canPushUpdates Σ0..1CodeableConceptyes | no | undetermined
can-push-updates (Preferred)
.... pushTypeAvailable 0..*CodeableConceptspecific | any | source
push-type-available (Preferred)
... attestation 0..1BackboneElementInformation about the entity attesting to information
.... source Σ0..1Reference(Practitioner)The individual attesting to information
.... organization Σ0..1Reference(Organization)The organization attesting to information
.... method Σ0..1CodeableConceptWho is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source)
.... date Σ0..1dateThe date the information was attested to
.... sourceIdentityCertificate 0..1stringA digital identity certificate associated with the attestation source
.... proxyIdentityCertificate 0..1stringA digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
.... signedProxyRight[x] 0..1Proxy signature
..... signedProxyRightStringstring
..... signedProxyRightUriuri
.... signedSourceAttestation[x] 0..1Attester signature
..... signedSourceAttestationStringstring
..... signedSourceAttestationUriuri
... validator 0..*BackboneElementInformation about the entity validating information
.... organization 1..1Reference(Organization)Reference to the organization validating information
.... identityCertificate 0..1stringA digital identity certificate associated with the validator
.... signedValidatorAttestation[x] 0..1Validator signature
..... signedValidatorAttestationStringstring
..... signedValidatorAttestationUriuri

doco Documentation for this format

UML Diagram (Legend)

VerificationResult (DomainResource)A resource that was validatedtarget : Reference [0..*] « Any »The fhirpath location(s) within the resource that was validatedtargetLocation : 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 (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 (Strength=Required)status! »When the validation status was updatedstatusDate : dateTime [0..1]What the target is validated against (nothing; primary source; multiple sources)validationType : CodeableConcept [0..1] « What the target is validated 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 [0..*] « The primary process by which the target is validated (Strength=Example)validation-process?? »Frequency of revalidationfrequency : 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 appropriatenextScheduled : date [0..1]The result if validation fails (fatal; warning; record only; none)failureAction : CodeableConcept [0..1] « The result if validation fails (Strength=Preferred)failure-action? »PrimarySourceReference to the primary sourceorganization : 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 [0..*] « Type of the validation primary source (Strength=Example)primary-source-type?? »Method for communicating with the primary source (manual; API; Push)validationProcess : CodeableConcept [0..*]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 (Strength=Preferred)validation-status? »When the target was validated against the primary sourcevalidationDate : 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 (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 (Strength=Preferred)push-type-available? »AttestationThe individual attesting to informationsource : Reference [0..1] « Practitioner »The organization attesting to informationorganization : Reference [0..1] « Organization »Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source)method : CodeableConcept [0..1]The date the information was attested todate : date [0..1]A digital identity certificate associated with the attestation sourcesourceIdentityCertificate : string [0..1]A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation sourceproxyIdentityCertificate : string [0..1]Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation sourcesignedProxyRight[x] : Type [0..1] « string|uri »Signed assertion by the attestation source that they have attested to the informationsignedSourceAttestation[x] : Type [0..1] « string|uri »ValidatorReference to the organization validating informationorganization : Reference [1..1] « Organization »A digital identity certificate associated with the validatoridentityCertificate : string [0..1]Signed assertion by the validator that they have validated the informationsignedValidatorAttestation[x] : Type [0..1] « string|uri »Information about the primary source(s) involved in validationprimarySource[0..*]Information about the entity attesting to informationattestation[0..1]Information about the entity validating informationvalidator[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 (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 -->
  <organization><!-- 0..1 Reference(Organization) Reference to the primary source --></organization>
  <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><!-- 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 -->
  <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: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 (incl. 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.organization [ Reference(Organization) ]; # 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.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: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: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: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
    # 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.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult DDomainResourceDescribes 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..*stringThe fhirpath location(s) within the resource that was validated
... need Σ0..1CodeableConceptnone | initial | periodic
need (Preferred)
... status Σ1..1codeattested | validated | in-process | req-revalid | val-fail | reval-fail
status (Required)
... statusDate Σ0..1dateTimeWhen the validation status was updated
... validationType Σ0..1CodeableConceptnothing | primary | multiple
validation-type (Preferred)
... validationProcess Σ0..*CodeableConceptThe primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context)
validation-process (Example)
... frequency 0..1TimingFrequency of revalidation
... lastPerformed 0..1dateTimeThe date/time validation was last completed (incl. failed validations)
... nextScheduled 0..1dateThe date when target is next validated, if appropriate
... failureAction Σ0..1CodeableConceptfatal | warn | rec-only | none
failure-action (Preferred)
... primarySource 0..*BackboneElementInformation about the primary source(s) involved in validation
.... organization 0..1Reference(Organization)Reference to the primary source
.... type Σ0..*CodeableConceptType of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source)
primary-source-type (Example)
.... validationProcess Σ0..*CodeableConceptThe process(es) by which the target is validated
.... validationStatus 0..1CodeableConceptsuccessful | failed | unknown
validation-status (Preferred)
.... validationDate 0..1dateTimeWhen the target was validated against the primary source
.... canPushUpdates Σ0..1CodeableConceptyes | no | undetermined
can-push-updates (Preferred)
.... pushTypeAvailable 0..*CodeableConceptspecific | any | source
push-type-available (Preferred)
... attestation 0..1BackboneElementInformation about the entity attesting to information
.... source Σ0..1Reference(Practitioner)The individual attesting to information
.... organization Σ0..1Reference(Organization)The organization attesting to information
.... method Σ0..1CodeableConceptWho is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source)
.... date Σ0..1dateThe date the information was attested to
.... sourceIdentityCertificate 0..1stringA digital identity certificate associated with the attestation source
.... proxyIdentityCertificate 0..1stringA digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
.... signedProxyRight[x] 0..1Proxy signature
..... signedProxyRightStringstring
..... signedProxyRightUriuri
.... signedSourceAttestation[x] 0..1Attester signature
..... signedSourceAttestationStringstring
..... signedSourceAttestationUriuri
... validator 0..*BackboneElementInformation about the entity validating information
.... organization 1..1Reference(Organization)Reference to the organization validating information
.... identityCertificate 0..1stringA digital identity certificate associated with the validator
.... signedValidatorAttestation[x] 0..1Validator signature
..... signedValidatorAttestationStringstring
..... signedValidatorAttestationUriuri

doco Documentation for this format

UML Diagram (Legend)

VerificationResult (DomainResource)A resource that was validatedtarget : Reference [0..*] « Any »The fhirpath location(s) within the resource that was validatedtargetLocation : 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 (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 (Strength=Required)status! »When the validation status was updatedstatusDate : dateTime [0..1]What the target is validated against (nothing; primary source; multiple sources)validationType : CodeableConcept [0..1] « What the target is validated 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 [0..*] « The primary process by which the target is validated (Strength=Example)validation-process?? »Frequency of revalidationfrequency : 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 appropriatenextScheduled : date [0..1]The result if validation fails (fatal; warning; record only; none)failureAction : CodeableConcept [0..1] « The result if validation fails (Strength=Preferred)failure-action? »PrimarySourceReference to the primary sourceorganization : 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 [0..*] « Type of the validation primary source (Strength=Example)primary-source-type?? »Method for communicating with the primary source (manual; API; Push)validationProcess : CodeableConcept [0..*]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 (Strength=Preferred)validation-status? »When the target was validated against the primary sourcevalidationDate : 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 (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 (Strength=Preferred)push-type-available? »AttestationThe individual attesting to informationsource : Reference [0..1] « Practitioner »The organization attesting to informationorganization : Reference [0..1] « Organization »Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source)method : CodeableConcept [0..1]The date the information was attested todate : date [0..1]A digital identity certificate associated with the attestation sourcesourceIdentityCertificate : string [0..1]A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation sourceproxyIdentityCertificate : string [0..1]Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation sourcesignedProxyRight[x] : Type [0..1] « string|uri »Signed assertion by the attestation source that they have attested to the informationsignedSourceAttestation[x] : Type [0..1] « string|uri »ValidatorReference to the organization validating informationorganization : Reference [1..1] « Organization »A digital identity certificate associated with the validatoridentityCertificate : string [0..1]Signed assertion by the validator that they have validated the informationsignedValidatorAttestation[x] : Type [0..1] « string|uri »Information about the primary source(s) involved in validationprimarySource[0..*]Information about the entity attesting to informationattestation[0..1]Information about the entity validating informationvalidator[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 (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 -->
  <organization><!-- 0..1 Reference(Organization) Reference to the primary source --></organization>
  <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><!-- 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 -->
  <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: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 (incl. 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.organization [ Reference(Organization) ]; # 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.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: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: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: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
    # 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

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

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

PathDefinitionTypeReference
VerificationResult.need The frequency with which the target must be validatedPreferredneed
VerificationResult.status The validation status of the targetRequiredstatus
VerificationResult.validationType What the target is validated againstPreferredvalidation-type
VerificationResult.validationProcess The primary process by which the target is validatedExamplevalidation-process
VerificationResult.failureAction The result if validation failsPreferredfailure-action
VerificationResult.primarySource.type Type of the validation primary sourceExampleprimary-source-type
VerificationResult.primarySource.validationStatus Status of the validation of the target against the primary sourcePreferredvalidation-status
VerificationResult.primarySource.canPushUpdates Ability of the primary source to push updates/alertsPreferredcan-push-updates
VerificationResult.primarySource.pushTypeAvailable Type of alerts/updates the primary source can sendPreferredpush-type-available

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
targetreferenceA resource that was validatedVerificationResult.target
(Any)