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
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 revalidatedvalidation.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 targetvalidation.lastCompleted
and validation.nextScheduled
describe the last completed and next scheduled dates of validation for the target, respectivelyvalidation.failureAction
describes what happens if the validation failsThe 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 issourceValidationProcess
indicates how an entity may communicate with the primary sourcesourceValidationStatus
, and sourceValidationDate
describe the status of the validation of the target against the primary sourcesourcePush
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 informationattestationMethod
indicates who is providing the attested informationattestationDate
indicates when the information was attested tosourceCert
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 identitysignedValidatorAttestation
asserts that the validator has validated the targetdateValidated
indicates when the validating organization validated the targetExamples:
The following are example uses for the vhdir-validation profile:
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:
validation.target
validation.failureAction
validation.primarySource.sourceType
validation.primarySource.sourceValidationProcess
validation.primarySource.sourcePush
validation.attestation.attestationSource
validation.validator.validatorOrg
Profile specific implementation guidance:
Extensions:
There are no extensions to the validation resource.
Terminology
TBD
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.
validation.target
validation.failureAction
validation.primarySource.sourceType
validation.primarySource.sourceValidationProcess
validation.primarySource.sourcePush
validation.attestation.attestationSource
validation.validator.validatorOrg
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
VerificationResult | 0..* | Validation | ||
id | S | 0..1 | id | |
meta | S | 0..1 | Meta | |
text | S | 0..1 | Narrative | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
VerificationResult | I | 0..* | Validation | |
id | SΣ | 0..1 | id | Logical id of this artifact |
meta | SΣ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | SI | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
target | Σ | 0..* | Reference(Resource) | A resource that was validated |
targetLocation | Σ | 0..* | string | The fhirpath location(s) within the resource that was validated |
need | Σ | 1..1 | code | none | initial | periodic Binding: need (required) |
status | Σ | 1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail Binding: status (required) |
statusDate | Σ | 1..1 | dateTime | When the validation status was updated |
validationType | Σ | 1..1 | code | nothing | primary | multiple Binding: validation-type (required) |
validationProcess | Σ | 1..* | CodeableConcept | The 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..1 | Timing | Frequency of revalidation | |
lastPerformed | 0..1 | dateTime | The date/time validation was last completed (incl. failed validations) | |
nextScheduled | 0..1 | date | The date when target is next validated, if appropriate | |
failureAction | Σ | 1..1 | code | fatal | warn | rec-only | none Binding: failure-action (required) |
primarySource | I | 0..* | BackboneElement | Information about the primary source(s) involved in validation |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..1 | Identifier | URI of the primary source for validation | |
organization | 0..1 | Reference(Organization) | Reference to the primary source | |
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) Binding: primary-source-type (example) |
validationProcess | Σ | 1..* | CodeableConcept | Method for communicating with the primary source (manual; API; Push) |
validationStatus | 0..1 | code | successful | failed | unknown Binding: validation-status (required) | |
validationDate | 0..1 | dateTime | When the target was validated against the primary source | |
canPushUpdates | Σ | 1..1 | code | yes | no | undetermined Binding: can-push-updates (required) |
pushTypeAvailable | 0..* | code | specific | any | source Binding: push-type-available (required) | |
attestation | I | 0..1 | BackboneElement | Information about the entity attesting to information |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
source | Σ | 1..1 | Reference(Practitioner) | The individual attesting to information |
organization | Σ | 1..1 | Reference(Organization) | The organization attesting to information |
method | Σ | 1..1 | CodeableConcept | Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source) |
date | Σ | 1..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 | |
validator | I | 0..* | BackboneElement | Information about the entity validating information |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..1 | Identifier | URI of the validator | |
organization | 1..1 | Reference(Organization) | Reference to the organization validating information | |
identityCertificate | 0..1 | string | A digital identity certificate associated with the validator | |
dateValidated | 1..1 | date | Date on which the validator last validated the information | |
Documentation for this format |
validation.target
validation.failureAction
validation.primarySource.sourceType
validation.primarySource.sourceValidationProcess
validation.primarySource.sourcePush
validation.attestation.attestationSource
validation.validator.validatorOrg
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
VerificationResult | 0..* | Validation | ||
id | S | 0..1 | id | |
meta | S | 0..1 | Meta | |
text | S | 0..1 | Narrative | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
VerificationResult | I | 0..* | Validation | |
id | SΣ | 0..1 | id | Logical id of this artifact |
meta | SΣ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | SI | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
target | Σ | 0..* | Reference(Resource) | A resource that was validated |
targetLocation | Σ | 0..* | string | The fhirpath location(s) within the resource that was validated |
need | Σ | 1..1 | code | none | initial | periodic Binding: need (required) |
status | Σ | 1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail Binding: status (required) |
statusDate | Σ | 1..1 | dateTime | When the validation status was updated |
validationType | Σ | 1..1 | code | nothing | primary | multiple Binding: validation-type (required) |
validationProcess | Σ | 1..* | CodeableConcept | The 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..1 | Timing | Frequency of revalidation | |
lastPerformed | 0..1 | dateTime | The date/time validation was last completed (incl. failed validations) | |
nextScheduled | 0..1 | date | The date when target is next validated, if appropriate | |
failureAction | Σ | 1..1 | code | fatal | warn | rec-only | none Binding: failure-action (required) |
primarySource | I | 0..* | BackboneElement | Information about the primary source(s) involved in validation |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..1 | Identifier | URI of the primary source for validation | |
organization | 0..1 | Reference(Organization) | Reference to the primary source | |
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) Binding: primary-source-type (example) |
validationProcess | Σ | 1..* | CodeableConcept | Method for communicating with the primary source (manual; API; Push) |
validationStatus | 0..1 | code | successful | failed | unknown Binding: validation-status (required) | |
validationDate | 0..1 | dateTime | When the target was validated against the primary source | |
canPushUpdates | Σ | 1..1 | code | yes | no | undetermined Binding: can-push-updates (required) |
pushTypeAvailable | 0..* | code | specific | any | source Binding: push-type-available (required) | |
attestation | I | 0..1 | BackboneElement | Information about the entity attesting to information |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
source | Σ | 1..1 | Reference(Practitioner) | The individual attesting to information |
organization | Σ | 1..1 | Reference(Organization) | The organization attesting to information |
method | Σ | 1..1 | CodeableConcept | Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source) |
date | Σ | 1..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 | |
validator | I | 0..* | BackboneElement | Information about the entity validating information |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..1 | Identifier | URI of the validator | |
organization | 1..1 | Reference(Organization) | Reference to the organization validating information | |
identityCertificate | 0..1 | string | A digital identity certificate associated with the validator | |
dateValidated | 1..1 | date | Date on which the validator last validated the information | |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron
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