Release 4 R5 Final QA

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-draft-final: Final QA Preview for R5 - Mixed Normative and STU see ballot notes ) in it's permanent home (it will always be available at this URL). ). 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 Content Examples Detailed Descriptions Mappings Profiles & Extensions 8.32 R3 Resource VerificationResult - Content R2

Example ValueSet/process-priority (JSON)

Patient Administration Terminology Infrastructure Work Group Maturity Level : 0   Trial Use N/A Security Category Standards Status : Business Informative Compartments : Not linked to any defined compartments
Describes validation requirements, source(s), status and dates for one or more elements. 8.32.1 Scope and Usage The VerificationResult can be used where content (such as found in a directory) is aggregated between systems, and the details of this process needs to be recorded, to be able to determine the likely accuracy of the content. 8.32.2 Boundaries and Relationships TBD. 8.32.3 Resource Content

Structure Name Flags Card. Type Description & Constraints VerificationResult TU DomainResource Describes validation requirements, source(s), status and dates for one or more elements Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension target Σ 0..* Reference ( Any ) A resource that was validated targetLocation Σ 0..* string The fhirpath location(s) within the resource that was validated need Σ 0..1 CodeableConcept none | initial | periodic Need ( Preferred ) status Σ 1..1 code attested | validated | in-process | req-revalid | val-fail | reval-fail Status ( Required ) statusDate Σ 0..1 dateTime When the validation status was updated validationType Σ 0..1 CodeableConcept nothing | primary | multiple Validation-type ( Preferred ) validationProcess Σ 0..* CodeableConcept The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context) Validation-process ( Example ) frequency 0..1 Timing Frequency of revalidation lastPerformed 0..1 dateTime The date/time validation was last completed (including failed validations) nextScheduled 0..1 date The date when target is next validated, if appropriate failureAction Σ 0..1 CodeableConcept fatal | warn | rec-only | none Failure-action ( Preferred ) primarySource 0..* BackboneElement Information about the primary source(s) involved in validation who 0..1 Reference ( Organization | Practitioner | PractitionerRole ) Reference to the primary source type Σ 0..* CodeableConcept Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source) Primary-source-type ( Example ) communicationMethod Σ 0..* CodeableConcept Method for exchanging information with the primary source VerificationResult Communication Method ( Example ) validationStatus 0..1 CodeableConcept successful | failed | unknown Validation-status ( Preferred ) validationDate 0..1 dateTime When the target was validated against the primary source canPushUpdates Σ 0..1 CodeableConcept yes | no | undetermined Can-push-updates ( Preferred ) pushTypeAvailable 0..* CodeableConcept specific | any | source Push-type-available ( Preferred ) attestation 0..1 BackboneElement Information about the entity attesting to information who Σ 0..1 Reference ( Practitioner | PractitionerRole | Organization ) The individual or organization attesting to information onBehalfOf Σ 0..1 Reference ( Organization | Practitioner | PractitionerRole ) When the who is asserting on behalf of another (organization or individual) communicationMethod Σ 0..1 CodeableConcept The method by which attested information was submitted/retrieved VerificationResult Communication Method ( Example ) date Σ 0..1 date The date the information was attested to sourceIdentityCertificate 0..1 string A digital identity certificate associated with the attestation source proxyIdentityCertificate 0..1 string A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source proxySignature 0..1 Signature Proxy signature sourceSignature 0..1 Signature Attester signature validator 0..* BackboneElement Information about the entity validating information organization 1..1 Reference Raw JSON ( Organization ) Reference to the organization validating information identityCertificate 0..1 string A digital identity certificate associated with the validator attestationSignature 0..1 Signature Validator signature Documentation for this format canonical form UML Diagram ( Legend + also see JSON Format Specification )

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

JSON Template Definition for Value SetProcess Priority Codes

{ "resourceType" : "", // from // from " " " " " " " " " " " " " " " " " " "
{
  "resourceType" : "ValueSet",
  "id" : "process-priority",
  "meta" : {
    "lastUpdated" : "2023-03-01T23:03:57.298+11:00",
    "profile" : ["http://hl7.org/fhir/StructureDefinition/shareablevalueset"]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><ul><li>Include all codes defined in <a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-processpriority.html\"><code>http://terminology.hl7.org/CodeSystem/processpriority</code></a></li></ul></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "fm"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "draft"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 1

  }],
  "
    "
    "
    "
    "
    "
    "
    "
    "

  "url" : "http://hl7.org/fhir/ValueSet/process-priority",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.3.552"

  },
  "
    "
    "
    "
  }]

  {
    "use" : "old",
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.3.544"
  },
  {
    "use" : "old",
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.2.319"
  }],
  "version" : "5.0.0-draft-final",
  "name" : "ProcessPriorityCodes",
  "title" : "Process Priority Codes",
  "status" : "draft",
  "experimental" : true,
  "publisher" : "Financial Management",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    }]
  }],
  "description" : "This value set includes the financial processing priority codes.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "code" : "001",
      "display" : "World"
    }]
  }],
  "copyright" : "This is an example set.",
  "compose" : {
    "include" : [{
      "system" : "http://terminology.hl7.org/CodeSystem/processpriority"
    }]
  }

}
Turtle Template @prefix fhir: <http://hl7.org/fhir/> . [ a fhir:; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ], ...; fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ]; fhir: fhir: fhir: fhir: ], ...; ] Changes since R3 This resource did not exist in Release 2 This analysis is available as XML or JSON . Structure Name Flags Card. Type Description & Constraints VerificationResult TU DomainResource Describes validation requirements, source(s), status and dates for one or more elements Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension target Σ 0..* Reference ( Any ) A resource that was validated targetLocation Σ 0..* string The fhirpath location(s) within the resource that was validated need Σ 0..1 CodeableConcept none | initial | periodic Need ( Preferred ) status Σ 1..1 code attested | validated | in-process | req-revalid | val-fail | reval-fail Status ( Required ) statusDate Σ 0..1 dateTime When the validation status was updated validationType Σ 0..1 CodeableConcept nothing | primary | multiple Validation-type ( Preferred ) validationProcess Σ 0..* CodeableConcept The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context) Validation-process ( Example ) frequency 0..1 Timing Frequency of revalidation lastPerformed 0..1 dateTime The date/time validation was last completed (including failed validations) nextScheduled 0..1 date The date when target is next validated, if appropriate failureAction Σ 0..1 CodeableConcept fatal | warn | rec-only | none Failure-action ( Preferred ) primarySource 0..* BackboneElement Information about the primary source(s) involved in validation who 0..1 Reference ( Organization | Practitioner | PractitionerRole ) Reference to the primary source type Σ 0..* CodeableConcept Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source) Primary-source-type ( Example ) communicationMethod Σ 0..* CodeableConcept Method for exchanging information with the primary source VerificationResult Communication Method ( Example ) validationStatus 0..1 CodeableConcept successful | failed | unknown Validation-status ( Preferred ) validationDate 0..1 dateTime When the target was validated against the primary source canPushUpdates Σ 0..1 CodeableConcept yes | no | undetermined Can-push-updates ( Preferred ) pushTypeAvailable 0..* CodeableConcept specific | any | source Push-type-available ( Preferred ) attestation 0..1 BackboneElement Information about the entity attesting to information who Σ 0..1 Reference ( Practitioner | PractitionerRole | Organization ) The individual or organization attesting to information onBehalfOf Σ 0..1 Reference ( Organization | Practitioner | PractitionerRole ) When the who is asserting on behalf of another (organization or individual) communicationMethod Σ 0..1 CodeableConcept The method by which attested information was submitted/retrieved VerificationResult Communication Method ( Example ) date Σ 0..1 date The date the information was attested to sourceIdentityCertificate 0..1 string A digital identity certificate associated with the attestation source proxyIdentityCertificate 0..1 string A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source proxySignature 0..1 Signature Proxy signature sourceSignature 0..1 Signature Attester signature validator 0..* BackboneElement Information about the entity validating information organization 1..1 Reference ( Organization ) Reference to the organization validating information identityCertificate 0..1 string A digital identity certificate associated with the validator attestationSignature 0..1 Signature Validator signature Documentation for this format

UML Diagram ( Legend ) VerificationResult ( DomainResource ) A resource that was validated target : Reference [0..*] « Any » The fhirpath location(s) within the resource that was validated targetLocation : string [0..*] The frequency with which the target must be validated (none; initial; periodic) need : CodeableConcept [0..1] « The frequency with which the target must be validated. (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 updated statusDate : dateTime [0..1] What the target is validated against (nothing; primary source; multiple sources) validationType : CodeableConcept [0..1] « What the target is validated against. (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 revalidation frequency : Timing [0..1] The date/time validation was last completed (including failed validations) lastPerformed : dateTime [0..1] The date when target is next validated, if appropriate nextScheduled : date [0..1] The result if validation fails (fatal; warning; record only; none) failureAction : CodeableConcept [0..1] « The result if validation fails. (Strength=Preferred) failure-action ? » PrimarySource Reference to the primary source who : Reference [0..1] « Organization | Practitioner | PractitionerRole » Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source) type : CodeableConcept [0..*] « Type of the validation primary source. (Strength=Example) primary-source-type ?? » Method for communicating with the primary source (manual; API; Push) communicationMethod : CodeableConcept [0..*] « Method for communicating with the data source (manual; API; Push). (Strength=Example) verificationresult-communicat... ?? » Status of the validation of the target against the primary source (successful; failed; unknown) validationStatus : CodeableConcept [0..1] « Status of the validation of the target against the primary source. (Strength=Preferred) validation-status ? » When the target was validated against the primary source validationDate : dateTime [0..1] Ability of the primary source to push updates/alerts (yes; no; undetermined) canPushUpdates : CodeableConcept [0..1] « Ability of the primary source to push updates/alerts. (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 ? » Attestation The individual or organization attesting to information who : Reference [0..1] « Practitioner | PractitionerRole | Organization » When the who is asserting on behalf of another (organization or individual) onBehalfOf : Reference [0..1] « Organization | Practitioner | PractitionerRole » The method by which attested information was submitted/retrieved (manual; API; Push) communicationMethod : CodeableConcept [0..1] « Method for communicating with the data source (manual; API; Push). (Strength=Example) verificationresult-communicat... ?? » The date the information was attested to date : date [0..1] A digital identity certificate associated with the attestation source sourceIdentityCertificate : string [0..1] A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source proxyIdentityCertificate : string [0..1] Signed assertion by the proxy entity indicating that they have the right Usage note: every effort has been made to submit attested information on behalf of the attestation source proxySignature : Signature [0..1] Signed assertion by the attestation source ensure that they have attested to the information sourceSignature : Signature [0..1] Validator Reference to the organization validating information organization : Reference [1..1] « Organization » A digital identity certificate associated with the validator identityCertificate : string [0..1] Signed assertion by the validator that examples are correct and useful, but they have validated the information attestationSignature : Signature [0..1] Information about the primary source(s) involved in validation primarySource [0..*] Information about the entity attesting to information attestation [0..1] Information about the entity validating information validator [0..*] XML Template < <!-- from --> <!-- from --> <</target> < <</need> < < <</validationType> <</validationProcess> <</frequency> < < <</failureAction> < <</who> <</type> <</communicationMethod> <</validationStatus> < <</canPushUpdates> <</pushTypeAvailable> </primarySource> < <</who> <</onBehalfOf> <</communicationMethod> < < < <</proxySignature> <</sourceSignature> </attestation> < <</organization> < <</attestationSignature> </validator> </VerificationResult> JSON Template { "resourceType" : "", // from // from " " " " " " " " " " " " " " " " " " " }], " " " " " " " " " }, " " " " }] } Turtle Template @prefix fhir: <http://hl7.org/fhir/> . [ a fhir:; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ], ...; fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ]; fhir: fhir: fhir: fhir: ], ...; ] Changes since Release 3 This resource did are not exist in Release 2 This analysis is available as XML or JSON .   See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions & the dependency analysis 8.32.3.1 Terminology Bindings Path Definition Type Reference VerificationResult.need The frequency with which the target must be validated. Preferred need VerificationResult.status The validation status of the target. Required status VerificationResult.validationType What the target is validated against. Preferred validation-type VerificationResult.validationProcess The primary process by which the target is validated. Example validation-process VerificationResult.failureAction The result if validation fails. Preferred failure-action VerificationResult.primarySource.type Type of the validation primary source. Example primary-source-type VerificationResult.primarySource.communicationMethod VerificationResult.attestation.communicationMethod Method for communicating with the data source (manual; API; Push). Example verificationresult-communication-method VerificationResult.primarySource.validationStatus Status of the validation of the target against the primary source. Preferred validation-status VerificationResult.primarySource.canPushUpdates Ability of the primary source to push updates/alerts. Preferred can-push-updates VerificationResult.primarySource.pushTypeAvailable Type a normative part of alerts/updates the primary source can send. Preferred push-type-available specification.

8.32.4 Notes:
8.32.5 Search Parameters Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services. Name Type Description Expression In Common target reference A resource that was validated VerificationResult.target (Any)