R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

8.35 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 Σ1..1codenone | initial | periodic
need (Required)
... status Σ1..1codeattested | validated | in-process | req-revalid | val-fail | reval-fail
status (Required)
... statusDate Σ1..1dateTimeWhen the validation status was updated
... validationType Σ1..1codenothing | primary | multiple
validation-type (Required)
... validationProcess Σ1..*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 Σ1..1codefatal | warn | rec-only | none
failure-action (Required)
... primarySource 0..*BackboneElementInformation about the primary source(s) involved in validation
.... identifier 0..1IdentifierURI of the primary source for validation
.... organization 0..1Reference(Organization)Reference to the primary source
.... type Σ1..*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 Σ1..*CodeableConceptMethod for communicating with the primary source (manual; API; Push)
.... validationStatus 0..1codesuccessful | failed | unknown
validation-status (Required)
.... validationDate 0..1dateTimeWhen the target was validated against the primary source
.... canPushUpdates Σ1..1codeyes | no | undetermined
can-push-updates (Required)
.... pushTypeAvailable 0..*codespecific | any | source
push-type-available (Required)
... attestation 0..1BackboneElementInformation about the entity attesting to information
.... source Σ1..1Reference(Practitioner)The individual attesting to information
.... organization Σ1..1Reference(Organization)The organization attesting to information
.... method Σ1..1CodeableConceptWho is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source)
.... date Σ1..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
... validator 0..*BackboneElementInformation about the entity validating information
.... identifier 0..1IdentifierURI of the validator
.... organization 1..1Reference(Organization)Reference to the organization validating information
.... identityCertificate 0..1stringA digital identity certificate associated with the validator
.... dateValidated 1..1dateDate on which the validator last validated the information

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 : code [1..1] « The frequency with which the target must be validated (Strength=Required)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 [1..1]What the target is validated against (nothing; primary source; multiple sources)validationType : code [1..1] « What the target is validated against (Strength=Required)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..*] « 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 : code [1..1] « The result if validation fails (Strength=Required)failure-action! »PrimarySourceURI of the primary source for validationidentifier : Identifier [0..1]Reference 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 [1..*] « Type of the validation primary source (Strength=Example)primary-source-type?? »Method for communicating with the primary source (manual; API; Push)validationProcess : CodeableConcept [1..*]Status of the validation of the target against the primary source (successful; failed; unknown)validationStatus : code [0..1] « Status of the validation of the target against the primary source (Strength=Required)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 : code [1..1] « Ability of the primary source to push updates/alerts (Strength=Required)can-push-updates! »Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source)pushTypeAvailable : code [0..*] « Type of alerts/updates the primary source can send (Strength=Required)push-type-available! »AttestationThe individual attesting to informationsource : Reference [1..1] « Practitioner »The organization attesting to informationorganization : Reference [1..1] « Organization »Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source)method : CodeableConcept [1..1]The date the information was attested todate : date [1..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]ValidatorURI of the validatoridentifier : Identifier [0..1]Reference to the organization validating informationorganization : Reference [1..1] « Organization »A digital identity certificate associated with the validatoridentityCertificate : string [0..1]Date on which the validator last validated the informationdateValidated : date [1..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 value="[code]"/><!-- 1..1 none | initial | periodic -->
 <status value="[code]"/><!-- 1..1 attested | validated | in-process | req-revalid | val-fail | reval-fail -->
 <statusDate value="[dateTime]"/><!-- 1..1 When the validation status was updated -->
 <validationType value="[code]"/><!-- 1..1 nothing | primary | multiple -->
 <validationProcess><!-- 1..* 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 value="[code]"/><!-- 1..1 fatal | warn | rec-only | none -->
 <primarySource>  <!-- 0..* Information about the primary source(s) involved in validation -->
  <identifier><!-- 0..1 Identifier URI of the primary source for validation --></identifier>
  <organization><!-- 0..1 Reference(Organization) Reference to the primary source --></organization>
  <type><!-- 1..* 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><!-- 1..* CodeableConcept Method for communicating with the primary source (manual; API; Push) --></validationProcess>
  <validationStatus value="[code]"/><!-- 0..1 successful | failed | unknown -->
  <validationDate value="[dateTime]"/><!-- 0..1 When the target was validated against the primary source -->
  <canPushUpdates value="[code]"/><!-- 1..1 yes | no | undetermined -->
  <pushTypeAvailable value="[code]"/><!-- 0..* specific | any | source -->
 </primarySource>
 <attestation>  <!-- 0..1 Information about the entity attesting to information -->
  <source><!-- 1..1 Reference(Practitioner) The individual attesting to information --></source>
  <organization><!-- 1..1 Reference(Organization) The organization attesting to information --></organization>
  <method><!-- 1..1 CodeableConcept Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source) --></method>
  <date value="[date]"/><!-- 1..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 -->
 </attestation>
 <validator>  <!-- 0..* Information about the entity validating information -->
  <identifier><!-- 0..1 Identifier URI of the validator --></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 -->
  <dateValidated value="[date]"/><!-- 1..1 Date on which the validator last validated the information -->
 </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" : "<code>", // R!  none | initial | periodic
  "status" : "<code>", // R!  attested | validated | in-process | req-revalid | val-fail | reval-fail
  "statusDate" : "<dateTime>", // R!  When the validation status was updated
  "validationType" : "<code>", // R!  nothing | primary | multiple
  "validationProcess" : [{ CodeableConcept }], // R!  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" : "<code>", // R!  fatal | warn | rec-only | none
  "primarySource" : [{ // Information about the primary source(s) involved in validation
    "identifier" : { Identifier }, // URI of the primary source for validation
    "organization" : { Reference(Organization) }, // Reference to the primary source
    "type" : [{ CodeableConcept }], // R!  Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source)
    "validationProcess" : [{ CodeableConcept }], // R!  Method for communicating with the primary source (manual; API; Push)
    "validationStatus" : "<code>", // successful | failed | unknown
    "validationDate" : "<dateTime>", // When the target was validated against the primary source
    "canPushUpdates" : "<code>", // R!  yes | no | undetermined
    "pushTypeAvailable" : ["<code>"] // specific | any | source
  }],
  "attestation" : { // Information about the entity attesting to information
    "source" : { Reference(Practitioner) }, // R!  The individual attesting to information
    "organization" : { Reference(Organization) }, // R!  The organization attesting to information
    "method" : { CodeableConcept }, // R!  Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source)
    "date" : "<date>", // R!  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
  },
  "validator" : [{ // Information about the entity validating information
    "identifier" : { Identifier }, // URI of the validator
    "organization" : { Reference(Organization) }, // R!  Reference to the organization validating information
    "identityCertificate" : "<string>", // A digital identity certificate associated with the validator
    "dateValidated" : "<date>" // R!  Date on which the validator last validated the information
  }]
}

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 [ code ]; # 1..1 none | initial | periodic
  fhir:VerificationResult.status [ code ]; # 1..1 attested | validated | in-process | req-revalid | val-fail | reval-fail
  fhir:VerificationResult.statusDate [ dateTime ]; # 1..1 When the validation status was updated
  fhir:VerificationResult.validationType [ code ]; # 1..1 nothing | primary | multiple
  fhir:VerificationResult.validationProcess [ CodeableConcept ], ... ; # 1..* 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 [ code ]; # 1..1 fatal | warn | rec-only | none
  fhir:VerificationResult.primarySource [ # 0..* Information about the primary source(s) involved in validation
    fhir:VerificationResult.primarySource.identifier [ Identifier ]; # 0..1 URI of the primary source for validation
    fhir:VerificationResult.primarySource.organization [ Reference(Organization) ]; # 0..1 Reference to the primary source
    fhir:VerificationResult.primarySource.type [ CodeableConcept ], ... ; # 1..* 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 ], ... ; # 1..* Method for communicating with the primary source (manual; API; Push)
    fhir:VerificationResult.primarySource.validationStatus [ code ]; # 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 [ code ]; # 1..1 yes | no | undetermined
    fhir:VerificationResult.primarySource.pushTypeAvailable [ code ], ... ; # 0..* specific | any | source
  ], ...;
  fhir:VerificationResult.attestation [ # 0..1 Information about the entity attesting to information
    fhir:VerificationResult.attestation.source [ Reference(Practitioner) ]; # 1..1 The individual attesting to information
    fhir:VerificationResult.attestation.organization [ Reference(Organization) ]; # 1..1 The organization attesting to information
    fhir:VerificationResult.attestation.method [ CodeableConcept ]; # 1..1 Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source)
    fhir:VerificationResult.attestation.date [ date ]; # 1..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.validator [ # 0..* Information about the entity validating information
    fhir:VerificationResult.validator.identifier [ Identifier ]; # 0..1 URI of the validator
    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.dateValidated [ date ]; # 1..1 Date on which the validator last validated the information
  ], ...;
]

Changes since DSTU2

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 Σ1..1codenone | initial | periodic
need (Required)
... status Σ1..1codeattested | validated | in-process | req-revalid | val-fail | reval-fail
status (Required)
... statusDate Σ1..1dateTimeWhen the validation status was updated
... validationType Σ1..1codenothing | primary | multiple
validation-type (Required)
... validationProcess Σ1..*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 Σ1..1codefatal | warn | rec-only | none
failure-action (Required)
... primarySource 0..*BackboneElementInformation about the primary source(s) involved in validation
.... identifier 0..1IdentifierURI of the primary source for validation
.... organization 0..1Reference(Organization)Reference to the primary source
.... type Σ1..*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 Σ1..*CodeableConceptMethod for communicating with the primary source (manual; API; Push)
.... validationStatus 0..1codesuccessful | failed | unknown
validation-status (Required)
.... validationDate 0..1dateTimeWhen the target was validated against the primary source
.... canPushUpdates Σ1..1codeyes | no | undetermined
can-push-updates (Required)
.... pushTypeAvailable 0..*codespecific | any | source
push-type-available (Required)
... attestation 0..1BackboneElementInformation about the entity attesting to information
.... source Σ1..1Reference(Practitioner)The individual attesting to information
.... organization Σ1..1Reference(Organization)The organization attesting to information
.... method Σ1..1CodeableConceptWho is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source)
.... date Σ1..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
... validator 0..*BackboneElementInformation about the entity validating information
.... identifier 0..1IdentifierURI of the validator
.... organization 1..1Reference(Organization)Reference to the organization validating information
.... identityCertificate 0..1stringA digital identity certificate associated with the validator
.... dateValidated 1..1dateDate on which the validator last validated the information

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 : code [1..1] « The frequency with which the target must be validated (Strength=Required)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 [1..1]What the target is validated against (nothing; primary source; multiple sources)validationType : code [1..1] « What the target is validated against (Strength=Required)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..*] « 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 : code [1..1] « The result if validation fails (Strength=Required)failure-action! »PrimarySourceURI of the primary source for validationidentifier : Identifier [0..1]Reference 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 [1..*] « Type of the validation primary source (Strength=Example)primary-source-type?? »Method for communicating with the primary source (manual; API; Push)validationProcess : CodeableConcept [1..*]Status of the validation of the target against the primary source (successful; failed; unknown)validationStatus : code [0..1] « Status of the validation of the target against the primary source (Strength=Required)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 : code [1..1] « Ability of the primary source to push updates/alerts (Strength=Required)can-push-updates! »Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source)pushTypeAvailable : code [0..*] « Type of alerts/updates the primary source can send (Strength=Required)push-type-available! »AttestationThe individual attesting to informationsource : Reference [1..1] « Practitioner »The organization attesting to informationorganization : Reference [1..1] « Organization »Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source)method : CodeableConcept [1..1]The date the information was attested todate : date [1..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]ValidatorURI of the validatoridentifier : Identifier [0..1]Reference to the organization validating informationorganization : Reference [1..1] « Organization »A digital identity certificate associated with the validatoridentityCertificate : string [0..1]Date on which the validator last validated the informationdateValidated : date [1..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 value="[code]"/><!-- 1..1 none | initial | periodic -->
 <status value="[code]"/><!-- 1..1 attested | validated | in-process | req-revalid | val-fail | reval-fail -->
 <statusDate value="[dateTime]"/><!-- 1..1 When the validation status was updated -->
 <validationType value="[code]"/><!-- 1..1 nothing | primary | multiple -->
 <validationProcess><!-- 1..* 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 value="[code]"/><!-- 1..1 fatal | warn | rec-only | none -->
 <primarySource>  <!-- 0..* Information about the primary source(s) involved in validation -->
  <identifier><!-- 0..1 Identifier URI of the primary source for validation --></identifier>
  <organization><!-- 0..1 Reference(Organization) Reference to the primary source --></organization>
  <type><!-- 1..* 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><!-- 1..* CodeableConcept Method for communicating with the primary source (manual; API; Push) --></validationProcess>
  <validationStatus value="[code]"/><!-- 0..1 successful | failed | unknown -->
  <validationDate value="[dateTime]"/><!-- 0..1 When the target was validated against the primary source -->
  <canPushUpdates value="[code]"/><!-- 1..1 yes | no | undetermined -->
  <pushTypeAvailable value="[code]"/><!-- 0..* specific | any | source -->
 </primarySource>
 <attestation>  <!-- 0..1 Information about the entity attesting to information -->
  <source><!-- 1..1 Reference(Practitioner) The individual attesting to information --></source>
  <organization><!-- 1..1 Reference(Organization) The organization attesting to information --></organization>
  <method><!-- 1..1 CodeableConcept Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source) --></method>
  <date value="[date]"/><!-- 1..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 -->
 </attestation>
 <validator>  <!-- 0..* Information about the entity validating information -->
  <identifier><!-- 0..1 Identifier URI of the validator --></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 -->
  <dateValidated value="[date]"/><!-- 1..1 Date on which the validator last validated the information -->
 </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" : "<code>", // R!  none | initial | periodic
  "status" : "<code>", // R!  attested | validated | in-process | req-revalid | val-fail | reval-fail
  "statusDate" : "<dateTime>", // R!  When the validation status was updated
  "validationType" : "<code>", // R!  nothing | primary | multiple
  "validationProcess" : [{ CodeableConcept }], // R!  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" : "<code>", // R!  fatal | warn | rec-only | none
  "primarySource" : [{ // Information about the primary source(s) involved in validation
    "identifier" : { Identifier }, // URI of the primary source for validation
    "organization" : { Reference(Organization) }, // Reference to the primary source
    "type" : [{ CodeableConcept }], // R!  Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source)
    "validationProcess" : [{ CodeableConcept }], // R!  Method for communicating with the primary source (manual; API; Push)
    "validationStatus" : "<code>", // successful | failed | unknown
    "validationDate" : "<dateTime>", // When the target was validated against the primary source
    "canPushUpdates" : "<code>", // R!  yes | no | undetermined
    "pushTypeAvailable" : ["<code>"] // specific | any | source
  }],
  "attestation" : { // Information about the entity attesting to information
    "source" : { Reference(Practitioner) }, // R!  The individual attesting to information
    "organization" : { Reference(Organization) }, // R!  The organization attesting to information
    "method" : { CodeableConcept }, // R!  Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source)
    "date" : "<date>", // R!  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
  },
  "validator" : [{ // Information about the entity validating information
    "identifier" : { Identifier }, // URI of the validator
    "organization" : { Reference(Organization) }, // R!  Reference to the organization validating information
    "identityCertificate" : "<string>", // A digital identity certificate associated with the validator
    "dateValidated" : "<date>" // R!  Date on which the validator last validated the information
  }]
}

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 [ code ]; # 1..1 none | initial | periodic
  fhir:VerificationResult.status [ code ]; # 1..1 attested | validated | in-process | req-revalid | val-fail | reval-fail
  fhir:VerificationResult.statusDate [ dateTime ]; # 1..1 When the validation status was updated
  fhir:VerificationResult.validationType [ code ]; # 1..1 nothing | primary | multiple
  fhir:VerificationResult.validationProcess [ CodeableConcept ], ... ; # 1..* 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 [ code ]; # 1..1 fatal | warn | rec-only | none
  fhir:VerificationResult.primarySource [ # 0..* Information about the primary source(s) involved in validation
    fhir:VerificationResult.primarySource.identifier [ Identifier ]; # 0..1 URI of the primary source for validation
    fhir:VerificationResult.primarySource.organization [ Reference(Organization) ]; # 0..1 Reference to the primary source
    fhir:VerificationResult.primarySource.type [ CodeableConcept ], ... ; # 1..* 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 ], ... ; # 1..* Method for communicating with the primary source (manual; API; Push)
    fhir:VerificationResult.primarySource.validationStatus [ code ]; # 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 [ code ]; # 1..1 yes | no | undetermined
    fhir:VerificationResult.primarySource.pushTypeAvailable [ code ], ... ; # 0..* specific | any | source
  ], ...;
  fhir:VerificationResult.attestation [ # 0..1 Information about the entity attesting to information
    fhir:VerificationResult.attestation.source [ Reference(Practitioner) ]; # 1..1 The individual attesting to information
    fhir:VerificationResult.attestation.organization [ Reference(Organization) ]; # 1..1 The organization attesting to information
    fhir:VerificationResult.attestation.method [ CodeableConcept ]; # 1..1 Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source)
    fhir:VerificationResult.attestation.date [ date ]; # 1..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.validator [ # 0..* Information about the entity validating information
    fhir:VerificationResult.validator.identifier [ Identifier ]; # 0..1 URI of the validator
    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.dateValidated [ date ]; # 1..1 Date on which the validator last validated the information
  ], ...;
]

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 validatedRequiredneed
VerificationResult.status The validation status of the targetRequiredstatus
VerificationResult.validationType What the target is validated againstRequiredvalidation-type
VerificationResult.validationProcess The primary process by which the target is validatedExamplevalidation-process
VerificationResult.failureAction The result if validation failsRequiredfailure-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 sourceRequiredvalidation-status
VerificationResult.primarySource.canPushUpdates Ability of the primary source to push updates/alertsRequiredcan-push-updates
VerificationResult.primarySource.pushTypeAvailable Type of alerts/updates the primary source can sendRequiredpush-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)