Validated Healthcare Directory IG STU1 Draft for Comment

This page is part of the Validated Healthcare Directory FHIR IG (v0.1.0: STU 1 Draft) based on FHIR v3.2.0. . For a full list of available versions, see the Directory of published versions

1.0 - StructureDefinition: vhdir-validation - Content

This profile sets minimum expectations for searching for and fetching information associated with validation. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the validation resource when using this profile.

Background & Scope

The need for validated provider data is the impetus for this implementation guide. We propose the creation of a new resource for conveying information about the validation of any other piece of data, including how it was validated, who validated it, and where the data came from.

The core of the validation resource includes basic information about how the data was validated:

  • validation.target represents the data that is being validated.The target may be a resource, attribute, or set of attributes.
  • validation.validationNeed and validation.frequency describe when the target should be validated, and how often it must be revalidated
  • validation.validationStatus describes the current status of validation for the target. validation.validationStatusDate indicates when the validation status was last updated.
  • validation.validationType describes what the target is validated against (i.e. whether it is validated against a single primary source, whether it is validated against multiple sources, or whether attested information is acceptable and it isn’t validated at all)
  • validation.validationProcess describes the primary validation process for the target
  • validation.lastCompleted and validation.nextScheduled describe the last completed and next scheduled dates of validation for the target, respectively
  • validation.failureAction describes what happens if the validation fails

The resource also provides information about entities involved in the validation process:

validation.primarySource provides information about the primary source(s) the target is validated against

  • source and sourceOrg identify the primary source, and sourceType indicates what the primary source is
  • sourceValidationProcess indicates how an entity may communicate with the primary source
  • sourceValidationStatus, and sourceValidationDate describe the status of the validation of the target against the primary source
  • sourcePush and sourcePushType indicate whether a primary source can push updates or alerts (e.g. if a license board suspends a practitioner’s license)

validation.attestation provides information about who submitted the information being validated

  • attestationSource identifies the individual attesting to information, attestationOrg identifies the organization attesting to information
  • In some cases, an indivudal my attest to information themself. In others, an entity may submit attested information on the individual’s behalf. attestationMethod indicates who is providing the attested information
  • attestationDate indicates when the information was attested to
  • sourceCert and proxyCert assert the identity of the individual attesting to information and any proxy providing attested information on their behalf. signedSourceAttestation and signedProxyRight assert that information was attested to/provided by the entity with the right to do so.

validation.validator provides information about the entity performing the validation of the target

  • validatorOrg identifes the validating organization, and validatorCert asserts their identity
  • signedValidatorAttestation asserts that the validator has validated the target
  • dateValidated indicates when the validating organization validated the target

Examples:

The following are example uses for the vhdir-validation profile:

  • TBD

Mandatory Data Elements

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each validation resource must have:

  1. At least one target in validation.target
  2. One indication of what happens if validation of the target fails in validation.failureAction
  3. For each primary source described:
    1. At least one type of primary source in validation.primarySource.sourceType
    2. At least one indication of the primary source validation process in validation.primarySource.sourceValidationProcess
    3. One indication of whether the primary source can push updates/alerts in validation.primarySource.sourcePush
  4. For each attestation source described:
    1. One individual that attested to the target information in validation.attestation.attestationSource
  5. For each validator described:
    1. One reference to the organization resource for the validator in validation.validator.validatorOrg

Profile specific implementation guidance:

  • TBD

Extensions:

There are no extensions to the validation resource.

Terminology

TBD

1.2 - Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/ig/vhdir/StructureDefinition/vhdir-validation

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

This profile builds on VerificationResult.

This profile was published on Mon Dec 11 04:42:47 AEDT 2017 as a draft by null.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

Complete Summary of the Mandatory Requirements

  1. At least one target in validation.target
  2. One indication of what happens if validation of the target fails in validation.failureAction
  3. For each primary source described:
    1. At least one type of primary source in validation.primarySource.sourceType
    2. At least one indication of the primary source validation process in validation.primarySource.sourceValidationProcess
    3. One indication of whether the primary source can push updates/alerts in validation.primarySource.sourcePush
  4. For each attestation source described:
    1. One individual that attested to the target information in validation.attestation.attestationSource
  5. For each validator described:
    1. One reference to the organization resource for the validator in validation.validator.validatorOrg
NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult I0..*Validation
... id SΣ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text SI0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target Σ0..*Reference(Resource)A resource that was validated
... targetLocation Σ0..*stringThe fhirpath location(s) within the resource that was validated
... need Σ1..1codenone | initial | periodic
Binding: need (required)
... status Σ1..1codeattested | validated | in-process | req-revalid | val-fail | reval-fail
Binding: status (required)
... statusDate Σ1..1dateTimeWhen the validation status was updated
... validationType Σ1..1codenothing | primary | multiple
Binding: 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)
Binding: 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
Binding: failure-action (required)
... primarySource I0..*BackboneElementInformation about the primary source(s) involved in validation
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... 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)
Binding: primary-source-type (example)
.... validationProcess Σ1..*CodeableConceptMethod for communicating with the primary source (manual; API; Push)
.... validationStatus 0..1codesuccessful | failed | unknown
Binding: validation-status (required)
.... validationDate 0..1dateTimeWhen the target was validated against the primary source
.... canPushUpdates Σ1..1codeyes | no | undetermined
Binding: can-push-updates (required)
.... pushTypeAvailable 0..*codespecific | any | source
Binding: push-type-available (required)
... attestation I0..1BackboneElementInformation about the entity attesting to information
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... 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 I0..*BackboneElementInformation about the entity validating information
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... 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

Complete Summary of the Mandatory Requirements

  1. At least one target in validation.target
  2. One indication of what happens if validation of the target fails in validation.failureAction
  3. For each primary source described:
    1. At least one type of primary source in validation.primarySource.sourceType
    2. At least one indication of the primary source validation process in validation.primarySource.sourceValidationProcess
    3. One indication of whether the primary source can push updates/alerts in validation.primarySource.sourcePush
  4. For each attestation source described:
    1. One individual that attested to the target information in validation.attestation.attestationSource
  5. For each validator described:
    1. One reference to the organization resource for the validator in validation.validator.validatorOrg

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult I0..*Validation
... id SΣ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text SI0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target Σ0..*Reference(Resource)A resource that was validated
... targetLocation Σ0..*stringThe fhirpath location(s) within the resource that was validated
... need Σ1..1codenone | initial | periodic
Binding: need (required)
... status Σ1..1codeattested | validated | in-process | req-revalid | val-fail | reval-fail
Binding: status (required)
... statusDate Σ1..1dateTimeWhen the validation status was updated
... validationType Σ1..1codenothing | primary | multiple
Binding: 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)
Binding: 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
Binding: failure-action (required)
... primarySource I0..*BackboneElementInformation about the primary source(s) involved in validation
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... 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)
Binding: primary-source-type (example)
.... validationProcess Σ1..*CodeableConceptMethod for communicating with the primary source (manual; API; Push)
.... validationStatus 0..1codesuccessful | failed | unknown
Binding: validation-status (required)
.... validationDate 0..1dateTimeWhen the target was validated against the primary source
.... canPushUpdates Σ1..1codeyes | no | undetermined
Binding: can-push-updates (required)
.... pushTypeAvailable 0..*codespecific | any | source
Binding: push-type-available (required)
... attestation I0..1BackboneElementInformation about the entity attesting to information
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... 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 I0..*BackboneElementInformation about the entity validating information
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... 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

Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron

 

1.3 - Quick Start

Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the US Core Server for a complete list of supported RESTful operations and search parameters for this IG.

TBD