Release 4B

This page is part of the FHIR Specification (v4.3.0: R4B - STU). 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.33 Resource VerificationResult - Content

Patient Administration Work GroupMaturity Level: 0 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

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

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.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.33.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult TUDomainResourceDescribes 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)
... 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 (including 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
.... who 0..1Reference(Organization | Practitioner | PractitionerRole)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)
.... communicationMethod Σ0..*CodeableConceptMethod for exchanging information with the primary source
VerificationResult Communication Method (Example)
.... 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
.... who Σ0..1Reference(Practitioner | PractitionerRole | Organization)The individual or organization attesting to information
.... onBehalfOf Σ0..1Reference(Organization | Practitioner | PractitionerRole)When the who is asserting on behalf of another (organization or individual)
.... communicationMethod Σ0..1CodeableConceptThe method by which attested information was submitted/retrieved
VerificationResult Communication Method (Example)
.... 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
.... proxySignature 0..1SignatureProxy signature
.... sourceSignature 0..1SignatureAttester signature
... 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
.... attestationSignature 0..1SignatureValidator signature

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] « null (Strength=Preferred)need? »The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed)status : code [1..1] « null (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] « 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..*] « null (Strength=Example)validation-process?? »Frequency of revalidationfrequency : 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 appropriatenextScheduled : date [0..1]The result if validation fails (fatal; warning; record only; none)failureAction : CodeableConcept [0..1] « null (Strength=Preferred)failure-action? »PrimarySourceReference to the primary sourcewho : 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..*] « null (Strength=Example)primary-source-type?? »Method for communicating with the primary source (manual; API; Push)communicationMethod : CodeableConcept [0..*] « null (Strength=Example) verificationresult-communicat...?? »Status of the validation of the target against the primary source (successful; failed; unknown)validationStatus : CodeableConcept [0..1] « null (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] « 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..*] « null (Strength=Preferred)push-type-available? »AttestationThe individual or organization attesting to informationwho : 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] « null (Strength=Example) verificationresult-communicat...?? »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 sourceproxySignature : Signature [0..1]Signed assertion by the attestation source that they have attested to the informationsourceSignature : Signature [0..1]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 informationattestationSignature : Signature [0..1]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 (including failed validations) -->
 <nextScheduled value="[date]"/><!-- 0..1 The date when target is next validated, if appropriate -->
 <failureAction><!-- 0..1 CodeableConcept fatal | warn | rec-only | none --></failureAction>
 <primarySource>  <!-- 0..* Information about the primary source(s) involved in validation -->
  <who><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Reference to the primary source --></who>
  <type><!-- 0..* CodeableConcept Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source) --></type>
  <communicationMethod><!-- 0..* CodeableConcept Method for exchanging information with the primary source --></communicationMethod>
  <validationStatus><!-- 0..1 CodeableConcept successful | failed | unknown --></validationStatus>
  <validationDate value="[dateTime]"/><!-- 0..1 When the target was validated against the primary source -->
  <canPushUpdates><!-- 0..1 CodeableConcept yes | no | undetermined --></canPushUpdates>
  <pushTypeAvailable><!-- 0..* CodeableConcept specific | any | source --></pushTypeAvailable>
 </primarySource>
 <attestation>  <!-- 0..1 Information about the entity attesting to information -->
  <who><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) The individual or organization attesting to information --></who>
  <onBehalfOf><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) When the who is asserting on behalf of another (organization or individual) --></onBehalfOf>
  <communicationMethod><!-- 0..1 CodeableConcept The method by which attested information was submitted/retrieved --></communicationMethod>
  <date value="[date]"/><!-- 0..1 The date the information was attested to -->
  <sourceIdentityCertificate value="[string]"/><!-- 0..1 A digital identity certificate associated with the attestation source -->
  <proxyIdentityCertificate value="[string]"/><!-- 0..1 A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source -->
  <proxySignature><!-- 0..1 Signature Proxy signature --></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: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 R4

VerificationResult
  • No Changes

See the Full Difference for further information

This analysis is available as XML or JSON.

Conversions between R3 and R4

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult TUDomainResourceDescribes 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)
... 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 (including 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
.... who 0..1Reference(Organization | Practitioner | PractitionerRole)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)
.... communicationMethod Σ0..*CodeableConceptMethod for exchanging information with the primary source
VerificationResult Communication Method (Example)
.... 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
.... who Σ0..1Reference(Practitioner | PractitionerRole | Organization)The individual or organization attesting to information
.... onBehalfOf Σ0..1Reference(Organization | Practitioner | PractitionerRole)When the who is asserting on behalf of another (organization or individual)
.... communicationMethod Σ0..1CodeableConceptThe method by which attested information was submitted/retrieved
VerificationResult Communication Method (Example)
.... 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
.... proxySignature 0..1SignatureProxy signature
.... sourceSignature 0..1SignatureAttester signature
... 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
.... attestationSignature 0..1SignatureValidator signature

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] « null (Strength=Preferred)need? »The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed)status : code [1..1] « null (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] « 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..*] « null (Strength=Example)validation-process?? »Frequency of revalidationfrequency : 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 appropriatenextScheduled : date [0..1]The result if validation fails (fatal; warning; record only; none)failureAction : CodeableConcept [0..1] « null (Strength=Preferred)failure-action? »PrimarySourceReference to the primary sourcewho : 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..*] « null (Strength=Example)primary-source-type?? »Method for communicating with the primary source (manual; API; Push)communicationMethod : CodeableConcept [0..*] « null (Strength=Example) verificationresult-communicat...?? »Status of the validation of the target against the primary source (successful; failed; unknown)validationStatus : CodeableConcept [0..1] « null (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] « 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..*] « null (Strength=Preferred)push-type-available? »AttestationThe individual or organization attesting to informationwho : 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] « null (Strength=Example) verificationresult-communicat...?? »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 sourceproxySignature : Signature [0..1]Signed assertion by the attestation source that they have attested to the informationsourceSignature : Signature [0..1]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 informationattestationSignature : Signature [0..1]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 (including failed validations) -->
 <nextScheduled value="[date]"/><!-- 0..1 The date when target is next validated, if appropriate -->
 <failureAction><!-- 0..1 CodeableConcept fatal | warn | rec-only | none --></failureAction>
 <primarySource>  <!-- 0..* Information about the primary source(s) involved in validation -->
  <who><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) Reference to the primary source --></who>
  <type><!-- 0..* CodeableConcept Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source) --></type>
  <communicationMethod><!-- 0..* CodeableConcept Method for exchanging information with the primary source --></communicationMethod>
  <validationStatus><!-- 0..1 CodeableConcept successful | failed | unknown --></validationStatus>
  <validationDate value="[dateTime]"/><!-- 0..1 When the target was validated against the primary source -->
  <canPushUpdates><!-- 0..1 CodeableConcept yes | no | undetermined --></canPushUpdates>
  <pushTypeAvailable><!-- 0..* CodeableConcept specific | any | source --></pushTypeAvailable>
 </primarySource>
 <attestation>  <!-- 0..1 Information about the entity attesting to information -->
  <who><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) The individual or organization attesting to information --></who>
  <onBehalfOf><!-- 0..1 Reference(Organization|Practitioner|PractitionerRole) When the who is asserting on behalf of another (organization or individual) --></onBehalfOf>
  <communicationMethod><!-- 0..1 CodeableConcept The method by which attested information was submitted/retrieved --></communicationMethod>
  <date value="[date]"/><!-- 0..1 The date the information was attested to -->
  <sourceIdentityCertificate value="[string]"/><!-- 0..1 A digital identity certificate associated with the attestation source -->
  <proxyIdentityCertificate value="[string]"/><!-- 0..1 A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source -->
  <proxySignature><!-- 0..1 Signature Proxy signature --></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: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 4

VerificationResult
  • No Changes

See the Full Difference for further information

This analysis is available as XML or JSON.

Conversions between R3 and R4

 

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.33.4.1 Terminology Bindings

PathDefinitionTypeReference
VerificationResult.need Preferredneed
VerificationResult.status Requiredstatus
VerificationResult.validationType Preferredvalidation-type
VerificationResult.validationProcess Examplevalidation-process
VerificationResult.failureAction Preferredfailure-action
VerificationResult.primarySource.type Exampleprimary-source-type
VerificationResult.primarySource.communicationMethod Exampleverificationresult-communication-method
VerificationResult.primarySource.validationStatus Preferredvalidation-status
VerificationResult.primarySource.canPushUpdates Preferredcan-push-updates
VerificationResult.primarySource.pushTypeAvailable Preferredpush-type-available
VerificationResult.attestation.communicationMethod Exampleverificationresult-communication-method

8.33.5 Notes:

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.

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