National Healthcare Directory Exchange
1.0.0-ballot - ballot US

This page is part of the National Healthcare Directory Exchange (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

Resource Profile: National Directory Validation

Official URL: http://hl7.org/fhir/us/directory-exchange/StructureDefinition/NatlDirEx-Validation Version: 1.0.0-ballot
Active as of 2022-08-09 Computable Name: NatlDirExValidation

Validation describes details about…

Usage:

Formal Views of Profile Content

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

This structure is derived from NatlDirEndpointQryVerification

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult 0..*NatlDirEndpointQryVerificationVerification
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..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 SΣ1..*Reference(Resource)A resource that was validated
... targetLocation SΣ0..*stringThe fhirpath location(s) within the resource that was validated
... need SΣ1..1CodeableConceptnone | initial | periodic
Binding: need (preferred): The frequency with which the target must be validated.

... status SΣ1..1codeattested | validated | in-process | req-revalid | val-fail | reval-fail
Binding: status (required): The validation status of the target.

... statusDate SΣ1..1dateTimeWhen the validation status was updated
... validationType SΣ1..1CodeableConceptnothing|single|multiple
Binding: validation-type (required)
... validationProcess SΣ1..*CodeableConceptThe process(es) by which the target is validated
Binding: Validation Type Value Set (example)
... frequency S0..1TimingFrequency of revalidation
... lastPerformed S0..1dateTimeThe date/time validation was last completed (including failed validations)
... nextScheduled S0..1dateThe date when target is next validated, if appropriate
... failureAction SΣ1..1CodeableConceptfatal | warn | rec-only | none
Binding: failure-action (preferred): The result if validation fails.

... primarySource S0..*BackboneElementInformation about the primary source(s) involved in validation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... who S0..1Reference(Organization | Practitioner | PractitionerRole)Reference to the primary source
.... type SΣ1..*CodeableConceptType of primary source
Binding: primary-source-type (example)
.... communicationMethod SΣ0..*CodeableConceptMethod for exchanging information with the primary source
Binding: verificationresult-communication-method (example)
.... validationStatus S0..1CodeableConceptsuccessful | failed | unknown
Binding: validation-status (preferred): Status of the validation of the target against the primary source.

.... validationDate S0..1dateTimeWhen the target was validated against the primary source
.... canPushUpdates SΣ0..1CodeableConceptyes | no | undetermined
Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts.

.... pushTypeAvailable S0..*CodeableConceptspecific | any | source
Binding: push-type-available (preferred): Type of alerts/updates the primary source can send.


... attestation S1..1BackboneElementInformation about the entity attesting to information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... who SΣ1..1Reference(Practitioner | PractitionerRole | Organization)The individual or organization attesting to information
.... onBehalfOf SΣ0..1Reference(Organization | Practitioner | PractitionerRole)When the who is asserting on behalf of another (organization or individual)
.... communicationMethod SΣ1..1CodeableConceptThe method by which attested information was submitted/retrieved
Binding: verificationresult-communication-method (example)
.... date SΣ1..1dateThe date the information was attested to
.... sourceIdentityCertificate S0..1stringA digital identity certificate associated with the attestation source
.... proxyIdentityCertificate S0..1stringA digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
.... proxySignature S0..1SignatureProxy signature
.... sourceSignature S0..1SignatureAttester signature
... validator S0..*BackboneElementInformation about the entity validating information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... organization S1..1Reference(Organization)Reference to the organization validating information
.... identityCertificate S0..1stringA digital identity certificate associated with the validator
.... attestationSignature S0..1SignatureValidator signature

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult 0..*NatlDirEndpointQryVerificationVerification
... target Σ1..*Reference(Resource)A resource that was validated
... targetLocation Σ0..*stringThe fhirpath location(s) within the resource that was validated
... need Σ1..1CodeableConceptnone | initial | periodic
Binding: need (preferred): The frequency with which the target must be validated.

... statusDate Σ1..1dateTimeWhen the validation status was updated
... validationType Σ1..1CodeableConceptnothing|single|multiple
Binding: validation-type (required)
... validationProcess Σ1..*CodeableConceptThe process(es) by which the target is validated
Binding: Validation Type Value Set (example)
... frequency 0..1TimingFrequency of revalidation
... lastPerformed 0..1dateTimeThe date/time validation was last completed (including failed validations)
... nextScheduled 0..1dateThe date when target is next validated, if appropriate
... failureAction Σ1..1CodeableConceptfatal | warn | rec-only | none
Binding: failure-action (preferred): The result if validation fails.

... primarySource 0..*BackboneElementInformation about the primary source(s) involved in validation
.... who 0..1Reference(Organization | Practitioner | PractitionerRole)Reference to the primary source
.... type Σ1..*CodeableConceptType of primary source
Binding: primary-source-type (example)
.... communicationMethod Σ0..*CodeableConceptMethod for exchanging information with the primary source
Binding: verificationresult-communication-method (example)
.... validationStatus 0..1CodeableConceptsuccessful | failed | unknown
Binding: validation-status (preferred): Status of the validation of the target against the primary source.

.... validationDate 0..1dateTimeWhen the target was validated against the primary source
.... canPushUpdates Σ0..1CodeableConceptyes | no | undetermined
Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts.

.... pushTypeAvailable 0..*CodeableConceptspecific | any | source
Binding: push-type-available (preferred): Type of alerts/updates the primary source can send.


... attestation 1..1BackboneElementInformation about the entity attesting to information
.... who Σ1..1Reference(Practitioner | PractitionerRole | Organization)The individual or organization attesting to information
.... onBehalfOf Σ0..1Reference(Organization | Practitioner | PractitionerRole)When the who is asserting on behalf of another (organization or individual)
.... communicationMethod Σ1..1CodeableConceptThe method by which attested information was submitted/retrieved
Binding: verificationresult-communication-method (example)
.... 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
.... proxySignature 0..1SignatureProxy signature
.... sourceSignature 0..1SignatureAttester signature
... validator 0..*BackboneElementInformation about the entity validating information
.... organization 1..1Reference(Organization)Reference to the organization validating information
.... identityCertificate 0..1stringA digital identity certificate associated with the validator
.... attestationSignature 0..1SignatureValidator signature

doco Documentation for this format

This structure is derived from NatlDirEndpointQryVerification

Summary

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult 0..*NatlDirEndpointQryVerificationVerification
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..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 SΣ1..*Reference(Resource)A resource that was validated
... targetLocation SΣ0..*stringThe fhirpath location(s) within the resource that was validated
... need SΣ1..1CodeableConceptnone | initial | periodic
Binding: need (preferred): The frequency with which the target must be validated.

... status SΣ1..1codeattested | validated | in-process | req-revalid | val-fail | reval-fail
Binding: status (required): The validation status of the target.

... statusDate SΣ1..1dateTimeWhen the validation status was updated
... validationType SΣ1..1CodeableConceptnothing|single|multiple
Binding: validation-type (required)
... validationProcess SΣ1..*CodeableConceptThe process(es) by which the target is validated
Binding: Validation Type Value Set (example)
... frequency S0..1TimingFrequency of revalidation
... lastPerformed S0..1dateTimeThe date/time validation was last completed (including failed validations)
... nextScheduled S0..1dateThe date when target is next validated, if appropriate
... failureAction SΣ1..1CodeableConceptfatal | warn | rec-only | none
Binding: failure-action (preferred): The result if validation fails.

... primarySource S0..*BackboneElementInformation about the primary source(s) involved in validation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... who S0..1Reference(Organization | Practitioner | PractitionerRole)Reference to the primary source
.... type SΣ1..*CodeableConceptType of primary source
Binding: primary-source-type (example)
.... communicationMethod SΣ0..*CodeableConceptMethod for exchanging information with the primary source
Binding: verificationresult-communication-method (example)
.... validationStatus S0..1CodeableConceptsuccessful | failed | unknown
Binding: validation-status (preferred): Status of the validation of the target against the primary source.

.... validationDate S0..1dateTimeWhen the target was validated against the primary source
.... canPushUpdates SΣ0..1CodeableConceptyes | no | undetermined
Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts.

.... pushTypeAvailable S0..*CodeableConceptspecific | any | source
Binding: push-type-available (preferred): Type of alerts/updates the primary source can send.


... attestation S1..1BackboneElementInformation about the entity attesting to information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... who SΣ1..1Reference(Practitioner | PractitionerRole | Organization)The individual or organization attesting to information
.... onBehalfOf SΣ0..1Reference(Organization | Practitioner | PractitionerRole)When the who is asserting on behalf of another (organization or individual)
.... communicationMethod SΣ1..1CodeableConceptThe method by which attested information was submitted/retrieved
Binding: verificationresult-communication-method (example)
.... date SΣ1..1dateThe date the information was attested to
.... sourceIdentityCertificate S0..1stringA digital identity certificate associated with the attestation source
.... proxyIdentityCertificate S0..1stringA digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
.... proxySignature S0..1SignatureProxy signature
.... sourceSignature S0..1SignatureAttester signature
... validator S0..*BackboneElementInformation about the entity validating information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... organization S1..1Reference(Organization)Reference to the organization validating information
.... identityCertificate S0..1stringA digital identity certificate associated with the validator
.... attestationSignature S0..1SignatureValidator signature

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
VerificationResult.languagepreferredCommonLanguages
Max Binding: AllLanguages
VerificationResult.needpreferredneed
VerificationResult.statusrequiredstatus
VerificationResult.validationTyperequiredvalidation-type
VerificationResult.validationProcessexampleValidationProcessVS
VerificationResult.failureActionpreferredfailure-action
VerificationResult.primarySource.typeexampleprimary-source-type
VerificationResult.primarySource.communicationMethodexampleverificationresult-communication-method
VerificationResult.primarySource.validationStatuspreferredvalidation-status
VerificationResult.primarySource.canPushUpdatespreferredcan-push-updates
VerificationResult.primarySource.pushTypeAvailablepreferredpush-type-available
VerificationResult.attestation.communicationMethodexampleverificationresult-communication-method