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

D.4.1.4 StructureDefinition: vhdir-validation - Detailed Descriptions

Definitions for the StructureDefinition-vhdir-validation Profile.

VerificationResult
Definition

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

Control0..*
InvariantsDefined on this element
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.all(('#'+id in %resource.descendants().reference) or descendants().where(reference = '#').exists()))
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
VerificationResult.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Must Supporttrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

VerificationResult.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Control0..1
TypeMeta
Must Supporttrue
VerificationResult.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

VerificationResult.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

VerificationResult.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Must Supporttrue
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

VerificationResult.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

VerificationResult.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

VerificationResult.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

VerificationResult.target
Definition

A resource that was validated.

Control0..*
TypeReference(Resource)
VerificationResult.targetLocation
Definition

The fhirpath location(s) within the resource that was validated.

Control0..*
Typestring
VerificationResult.need
Definition

The frequency with which the target must be validated (none; initial; periodic).

Control1..1
BindingThe frequency with which the target must be validated
The codes SHALL be taken from need
Typecode
VerificationResult.status
Definition

The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed).

Control1..1
BindingThe validation status of the target
The codes SHALL be taken from status
Typecode
VerificationResult.statusDate
Definition

When the validation status was updated.

Control1..1
TypedateTime
VerificationResult.validationType
Definition

What the target is validated against (nothing; primary source; multiple sources).

Control1..1
BindingWhat the target is validated against
The codes SHALL be taken from validation-type
Typecode
VerificationResult.validationProcess
Definition

The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).

Control1..*
BindingThe primary process by which the target is validated
For example codes, see validation-process
TypeCodeableConcept
VerificationResult.frequency
Definition

Frequency of revalidation.

Control0..1
TypeTiming
VerificationResult.lastPerformed
Definition

The date/time validation was last completed (incl. failed validations).

Control0..1
TypedateTime
VerificationResult.nextScheduled
Definition

The date when target is next validated, if appropriate.

Control0..1
Typedate
VerificationResult.failureAction
Definition

The result if validation fails (fatal; warning; record only; none).

Control1..1
BindingThe result if validation fails
The codes SHALL be taken from failure-action
Typecode
VerificationResult.primarySource
Definition

Information about the primary source(s) involved in validation.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
VerificationResult.primarySource.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
VerificationResult.primarySource.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

VerificationResult.primarySource.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

VerificationResult.primarySource.identifier
Definition

URI of the primary source for validation.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
VerificationResult.primarySource.organization
Definition

Reference to the primary source.

Control0..1
TypeReference(Organization)
VerificationResult.primarySource.type
Definition

Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source).

Control1..*
BindingType of the validation primary source
For example codes, see primary-source-type
TypeCodeableConcept
VerificationResult.primarySource.validationProcess
Definition

Method for communicating with the primary source (manual; API; Push).

Control1..*
TypeCodeableConcept
VerificationResult.primarySource.validationStatus
Definition

Status of the validation of the target against the primary source (successful; failed; unknown).

Control0..1
BindingStatus of the validation of the target against the primary source
The codes SHALL be taken from validation-status
Typecode
VerificationResult.primarySource.validationDate
Definition

When the target was validated against the primary source.

Control0..1
TypedateTime
VerificationResult.primarySource.canPushUpdates
Definition

Ability of the primary source to push updates/alerts (yes; no; undetermined).

Control1..1
BindingAbility of the primary source to push updates/alerts
The codes SHALL be taken from can-push-updates
Typecode
VerificationResult.primarySource.pushTypeAvailable
Definition

Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source).

Control0..*
BindingType of alerts/updates the primary source can send
The codes SHALL be taken from push-type-available
Typecode
VerificationResult.attestation
Definition

Information about the entity attesting to information.

Control0..1
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
VerificationResult.attestation.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
VerificationResult.attestation.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

VerificationResult.attestation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

VerificationResult.attestation.source
Definition

The individual attesting to information.

Control1..1
TypeReference(Practitioner)
VerificationResult.attestation.organization
Definition

The organization attesting to information.

Control1..1
TypeReference(Organization)
VerificationResult.attestation.method
Definition

Who is providing the attested information (owner; authorized representative; authorized intermediary; non-authorized source).

Control1..1
TypeCodeableConcept
VerificationResult.attestation.date
Definition

The date the information was attested to.

Control1..1
Typedate
VerificationResult.attestation.sourceIdentityCertificate
Definition

A digital identity certificate associated with the attestation source.

Control0..1
Typestring
VerificationResult.attestation.proxyIdentityCertificate
Definition

A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source.

Control0..1
Typestring
VerificationResult.validator
Definition

Information about the entity validating information.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
VerificationResult.validator.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
VerificationResult.validator.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

VerificationResult.validator.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

VerificationResult.validator.identifier
Definition

URI of the validator.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
VerificationResult.validator.organization
Definition

Reference to the organization validating information.

Control1..1
TypeReference(Organization)
VerificationResult.validator.identityCertificate
Definition

A digital identity certificate associated with the validator.

Control0..1
Typestring
VerificationResult.validator.dateValidated
Definition

Date on which the validator last validated the information.

Control1..1
Typedate