National Healthcare Directory Attestation and Verification
1.0.0-ballot - ballot

National Healthcare Directory Attestation and Verification, published by HL7 Patient Administration Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0-ballot). This version is based on the current content of https://github.com/HL7/fhir-directory-attestation/ and changes regularly. See the Directory of published versions

## Resource Profile: NatlDirAttestValidation - Detailed Descriptions

Active as of 2017-12-10

Definitions for the NatlDir-Validation resource profile.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here.

1. VerificationResult
Definition | Describes validation requirements, source(s), status and dates for one or more elements Describes validation requirements, source(s), status and dates for one or more elements.
2. VerificationResult.target
Control | 10..*
Must Support | true
3. VerificationResult.targetLocation
Must Support | true
4. VerificationResult.need
Control | 10..1
Must Support | true
5. VerificationResult.status
Must Support | true
6. VerificationResult.statusDate
Control | 10..1
Must Support | true
7. VerificationResult.validationType
Definition | What the target is validated against (nothing|single source|multiple sources) What the target is validated against (nothing; primary source; multiple sources).
Control | 10..1
Binding | The codes SHALL be taken from validation-type The codes SHOULD be taken from validation-type
Must Support | true
8. VerificationResult.validationProcess
Definition | The process(es) by which the target is validated The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).
Control | 10..*
Must Support | true
9. VerificationResult.frequency
Must Support | true
10. VerificationResult.lastPerformed
Must Support | true
11. VerificationResult.nextScheduled
Must Support | true
12. VerificationResult.failureAction
Control | 10..1
Must Support | true
13. VerificationResult.primarySource
Must Support | true
14. VerificationResult.primarySource.who
Must Support | true
15. VerificationResult.primarySource.type
Definition | Type of primary source Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source).
Control | 10..*
Must Support | true
16. VerificationResult.primarySource.communicationMethod
Must Support | true
17. VerificationResult.primarySource.validationStatus
Must Support | true
18. VerificationResult.primarySource.validationDate
Must Support | true
19. VerificationResult.primarySource.canPushUpdates
Must Support | true
20. VerificationResult.primarySource.pushTypeAvailable
Must Support | true
21. VerificationResult.attestation
Control | 10..1
Must Support | true
22. VerificationResult.attestation.who
Control | 10..1
Must Support | true
23. VerificationResult.attestation.onBehalfOf
Must Support | true
24. VerificationResult.attestation.communicationMethod
Control | 10..1
Must Support | true
25. VerificationResult.attestation.date
Control | 10..1
Must Support | true
26. VerificationResult.attestation.sourceIdentityCertificate
Must Support | true
27. VerificationResult.attestation.proxyIdentityCertificate
Must Support | true
28. VerificationResult.attestation.proxySignature
Must Support | true
29. VerificationResult.attestation.sourceSignature
Must Support | true
30. VerificationResult.validator
Must Support | true
31. VerificationResult.validator.organization
Must Support | true
32. VerificationResult.validator.identityCertificate
Must Support | true
33. VerificationResult.validator.attestationSignature
Must Support | true

Guidance on how to interpret the contents of this table can be found here.

1. VerificationResult
Definition | Describes validation requirements, source(s), status and dates for one or more elements Describes validation requirements, source(s), status and dates for one or more elements.
Control | 0..*
Invariants | Defined on this element 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.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) 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()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists())
2. 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is Modifier | true
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
4. VerificationResult.target
Definition | A resource that was validated.
Control | 10..*
Type | Reference(Resource)
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. VerificationResult.targetLocation
Definition | The fhirpath location(s) within the resource that was validated.
Control | 0..*
Type | string
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. VerificationResult.need
Definition | The frequency with which the target must be validated (none; initial; periodic).
Control | 10..1
Binding | The codes SHOULD be taken from need The frequency with which the target must be validated.
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. VerificationResult.status
Definition | The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed).
Control | 1..1
Binding | The codes SHALL be taken from status The validation status of the target.
Type | code
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. VerificationResult.statusDate
Definition | When the validation status was updated.
Control | 10..1
Type | dateTime
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. VerificationResult.validationType
Definition | What the target is validated against (nothing|single source|multiple sources) What the target is validated against (nothing; primary source; multiple sources).
Control | 10..1
Binding | The codes SHALL be taken from validation-type The codes SHOULD be taken from validation-type
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. VerificationResult.validationProcess
Definition | The process(es) by which the target is validated The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).
Control | 10..*
Binding | For example codes, see validation-process The primary process by which the target is validated.
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. VerificationResult.frequency
Definition | Frequency of revalidation.
Control | 0..1
Type | Timing
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. VerificationResult.lastPerformed
Definition | The date/time validation was last completed (including failed validations).
Control | 0..1
Type | dateTime
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. VerificationResult.nextScheduled
Definition | The date when target is next validated, if appropriate.
Control | 0..1
Type | date
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. VerificationResult.failureAction
Definition | The result if validation fails (fatal; warning; record only; none).
Control | 10..1
Binding | The codes SHOULD be taken from failure-action The result if validation fails.
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. VerificationResult.primarySource
Definition | Information about the primary source(s) involved in validation.
Control | 0..*
Type | BackboneElement
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
17. VerificationResult.primarySource.who
Definition | Reference to the primary source.
Control | 0..1
Type | Reference(Organization|Practitioner|PractitionerRole)
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. VerificationResult.primarySource.type
Definition | Type of primary source Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source).
Control | 10..*
Binding | For example codes, see primary-source-type
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. VerificationResult.primarySource.communicationMethod
Definition | Method for communicating with the primary source (manual; API; Push).
Control | 0..*
Binding | For example codes, see verificationresult-communication-method
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. VerificationResult.primarySource.validationStatus
Definition | Status of the validation of the target against the primary source (successful; failed; unknown).
Control | 0..1
Binding | The codes SHOULD be taken from validation-status Status of the validation of the target against the primary source.
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. VerificationResult.primarySource.validationDate
Definition | When the target was validated against the primary source.
Control | 0..1
Type | dateTime
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. VerificationResult.primarySource.canPushUpdates
Definition | Ability of the primary source to push updates/alerts (yes; no; undetermined).
Control | 0..1
Binding | The codes SHOULD be taken from can-push-updates Ability of the primary source to push updates/alerts.
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. VerificationResult.primarySource.pushTypeAvailable
Definition | Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source).
Control | 0..*
Binding | The codes SHOULD be taken from push-type-available Type of alerts/updates the primary source can send.
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. VerificationResult.attestation
Definition | Information about the entity attesting to information.
Control | 10..1
Type | BackboneElement
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
26. VerificationResult.attestation.who
Definition | The individual or organization attesting to information.
Control | 10..1
Type | Reference(Practitioner|PractitionerRole|Organization)
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. VerificationResult.attestation.onBehalfOf
Definition | When the who is asserting on behalf of another (organization or individual).
Control | 0..1
Type | Reference(Organization|Practitioner|PractitionerRole)
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. VerificationResult.attestation.communicationMethod
Definition | The method by which attested information was submitted/retrieved (manual; API; Push).
Control | 10..1
Binding | For example codes, see verificationresult-communication-method
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. VerificationResult.attestation.date
Definition | The date the information was attested to.
Control | 10..1
Type | date
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. VerificationResult.attestation.sourceIdentityCertificate
Definition | A digital identity certificate associated with the attestation source.
Control | 0..1
Type | string
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. VerificationResult.attestation.proxyIdentityCertificate
Definition | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source.
Control | 0..1
Type | string
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. VerificationResult.attestation.proxySignature
Definition | Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source.
Control | 0..1
Type | Signature
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. VerificationResult.attestation.sourceSignature
Definition | Signed assertion by the attestation source that they have attested to the information.
Control | 0..1
Type | Signature
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. VerificationResult.validator
Definition | Information about the entity validating information.
Control | 0..*
Type | BackboneElement
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
36. VerificationResult.validator.organization
Definition | Reference to the organization validating information.
Control | 1..1
Type | Reference(Organization)
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. VerificationResult.validator.identityCertificate
Definition | A digital identity certificate associated with the validator.
Control | 0..1
Type | string
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. VerificationResult.validator.attestationSignature
Definition | Signed assertion by the validator that they have validated the information.
Control | 0..1
Type | Signature
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

1. VerificationResult
Definition | Describes validation requirements, source(s), status and dates for one or more elements
Control | 0..*
2. VerificationResult.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Control | 0..1
Type | id
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.
3. 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.
Control | 0..1
Type | Meta
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Control | 0..1
Type | uri
Is Modifier | true
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. VerificationResult.language
Definition | The base language in which the resource is written.
Control | 0..1
Binding | The codes SHOULD be taken from CommonLanguages A human language
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
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).
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. VerificationResult.text
Definition | A human-readable narrative that contains a summary of the resource and can 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.
Control | 0..1
Type | Narrative
Alternate Names | narrative, 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 information is added later.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. 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.
Control | 0..*
Type | Resource
Alternate Names | inline 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
8. VerificationResult.extension
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensions, 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
9. 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. VerificationResult.target
Definition | A resource that was validated.
Control | 1..*
Type | Reference(Resource)
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. VerificationResult.targetLocation
Definition | The fhirpath location(s) within the resource that was validated.
Control | 0..*
Type | string
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. VerificationResult.need
Definition | The frequency with which the target must be validated (none; initial; periodic).
Control | 1..1
Binding | The codes SHOULD be taken from need The frequency with which the target must be validated
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. VerificationResult.status
Definition | The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed).
Control | 1..1
Binding | The codes SHALL be taken from status The validation status of the target
Type | code
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. VerificationResult.statusDate
Definition | When the validation status was updated.
Control | 1..1
Type | dateTime
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. VerificationResult.validationType
Definition | What the target is validated against (nothing|single source|multiple sources)
Control | 1..1
Binding | The codes SHALL be taken from validation-type
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. VerificationResult.validationProcess
Definition | The process(es) by which the target is validated
Control | 1..*
Binding | For example codes, see validation-process The primary process by which the target is validated
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. VerificationResult.frequency
Definition | Frequency of revalidation.
Control | 0..1
Type | Timing
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. VerificationResult.lastPerformed
Definition | The date/time validation was last completed (including failed validations).
Control | 0..1
Type | dateTime
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. VerificationResult.nextScheduled
Definition | The date when target is next validated, if appropriate.
Control | 0..1
Type | date
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. VerificationResult.failureAction
Definition | The result if validation fails (fatal; warning; record only; none).
Control | 1..1
Binding | The codes SHOULD be taken from failure-action The result if validation fails
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. VerificationResult.primarySource
Definition | Information about the primary source(s) involved in validation.
Control | 0..*
Type | BackboneElement
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. 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.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
23. VerificationResult.primarySource.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensions, 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
24. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
25. VerificationResult.primarySource.who
Definition | Reference to the primary source.
Control | 0..1
Type | Reference(Organization|Practitioner|PractitionerRole)
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. VerificationResult.primarySource.type
Definition | Type of primary source
Control | 1..*
Binding | For example codes, see primary-source-type
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. VerificationResult.primarySource.communicationMethod
Definition | Method for communicating with the primary source (manual; API; Push).
Control | 0..*
Binding | For example codes, see verificationresult-communication-method
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. VerificationResult.primarySource.validationStatus
Definition | Status of the validation of the target against the primary source (successful; failed; unknown).
Control | 0..1
Binding | The codes SHOULD be taken from validation-status Status of the validation of the target against the primary source
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. VerificationResult.primarySource.validationDate
Definition | When the target was validated against the primary source.
Control | 0..1
Type | dateTime
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. VerificationResult.primarySource.canPushUpdates
Definition | Ability of the primary source to push updates/alerts (yes; no; undetermined).
Control | 0..1
Binding | The codes SHOULD be taken from can-push-updates Ability of the primary source to push updates/alerts
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. VerificationResult.primarySource.pushTypeAvailable
Definition | Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source).
Control | 0..*
Binding | The codes SHOULD be taken from push-type-available Type of alerts/updates the primary source can send
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. VerificationResult.attestation
Definition | Information about the entity attesting to information.
Control | 1..1
Type | BackboneElement
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
33. 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.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
34. VerificationResult.attestation.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensions, 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
35. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
36. VerificationResult.attestation.who
Definition | The individual or organization attesting to information.
Control | 1..1
Type | Reference(Practitioner|PractitionerRole|Organization)
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. VerificationResult.attestation.onBehalfOf
Definition | When the who is asserting on behalf of another (organization or individual).
Control | 0..1
Type | Reference(Organization|Practitioner|PractitionerRole)
Must Support | true
Must Support Types | No must-support rules about the choice of types/profiles
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. VerificationResult.attestation.communicationMethod
Definition | The method by which attested information was submitted/retrieved (manual; API; Push).
Control | 1..1
Binding | For example codes, see verificationresult-communication-method
Type | CodeableConcept
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. VerificationResult.attestation.date
Definition | The date the information was attested to.
Control | 1..1
Type | date
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. VerificationResult.attestation.sourceIdentityCertificate
Definition | A digital identity certificate associated with the attestation source.
Control | 0..1
Type | string
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. VerificationResult.attestation.proxyIdentityCertificate
Definition | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source.
Control | 0..1
Type | string
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. VerificationResult.attestation.proxySignature
Definition | Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source.
Control | 0..1
Type | Signature
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
43. VerificationResult.attestation.sourceSignature
Definition | Signed assertion by the attestation source that they have attested to the information.
Control | 0..1
Type | Signature
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
44. VerificationResult.validator
Definition | Information about the entity validating information.
Control | 0..*
Type | BackboneElement
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. 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.
Control | 0..1
Type | string
XML Representation | In the XML format, this property is represented as an attribute.
46. VerificationResult.validator.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Control | 0..*
Type | Extension
Alternate Names | extensions, 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
47. 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Control | 0..*
Type | Extension
Is Modifier | true
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names | extensions, 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.
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
48. VerificationResult.validator.organization
Definition | Reference to the organization validating information.
Control | 1..1
Type | Reference(Organization)
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. VerificationResult.validator.identityCertificate
Definition | A digital identity certificate associated with the validator.
Control | 0..1
Type | string
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. VerificationResult.validator.attestationSignature
Definition | Signed assertion by the validator that they have validated the information.
Control | 0..1
Type | Signature
Must Support | true
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))