FHIR Osiris Implementation Guide
2.1.0 - ci-build

FHIR Osiris Implementation Guide - Local Development build (v2.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: DataValidation - Detailed Descriptions

Draft as of 2024-03-21

Definitions for the data-validation resource profile.

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

0. VerificationResult
2. VerificationResult.target
Control1..1
TypeReference(Single Nucleotide Polymorphism, Gene Fusion, Gene Expression, Variant Copy Number)
Must Supporttrue
Must Support TypesNo must-support rules about the choice of types/profiles
4. VerificationResult.status
Definition

Allows to indicate if the alteration has been validated or not by the validation method.

ShortValidation status of the detected alteration (attested | validated | in-process | req-revalid | val-fail | reval-fail)
Must Supporttrue
6. VerificationResult.validationType
Definition

Validation method used (Experimental | By biologist | In silico).

ShortType of validation of the detected alteration (Experimental | By biologist | In silico)
Control1..?
BindingUnless not suitable, these codes SHALL be taken from Osiris Validation Type
(extensible to https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/OsirisValidationType)
Must Supporttrue
8. VerificationResult.validationProcess
Definition

Allows you to indicate a validation method (example: bibliographic)

ShortValidation method
Control0..1
Must Supporttrue

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

0. VerificationResult
Definition

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

ShortDescribes validation requirements, source(s), status and dates for one or more elements
Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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-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-6: A resource should have narrative for robust management (text.`div`.exists())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
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.

ShortA set of rules under which this content was created
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.

Control0..1
This element is affected by the following invariants: ele-1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. 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).

ShortExtensions that cannot be ignored
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Standards StatusNormative (from Trial Use)
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 Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on VerificationResult.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. VerificationResult.target
    Definition

    A resource that was validated.

    ShortA resource that was validated
    Comments

    References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

    Control10..1*
    This element is affected by the following invariants: ele-1
    TypeReference(Single Nucleotide Polymorphism, Gene Fusion, Gene Expression, Variant Copy Number, Resource)
    Must Supporttrue
    Must Support TypesNo must-support rules about the choice of types/profiles
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
    8. VerificationResult.status
    Definition

    Allows to indicate if the alteration has been validated or not by the validation method.


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

    ShortValidation status of the detected alteration (attested | validated | in-process | req-revalid | val-fail | reval-fail)attested | validated | in-process | req-revalid | val-fail | reval-fail
    Comments

    Note that FHIR strings SHALL NOT exceed 1MB in size

    Control1..1
    This element is affected by the following invariants: ele-1
    BindingThe codes SHALL be taken from statushttp://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1
    (required to http://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1)

    The validation status of the target.

    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. VerificationResult.validationType
    Definition

    Validation method used (Experimental | By biologist | In silico).


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

    ShortType of validation of the detected alteration (Experimental | By biologist | In silico)nothing | primary | multiple
    Comments

    Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

    Control10..1
    This element is affected by the following invariants: ele-1
    BindingUnless not suitable, these codes SHALL be taken from The codes SHOULD be taken from Osiris Validation Typehttp://hl7.org/fhir/ValueSet/verificationresult-validation-type
    (extensible to https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/OsirisValidationType)
    TypeCodeableConcept
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. VerificationResult.validationProcess
    Definition

    Allows you to indicate a validation method (example: bibliographic)


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

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

    Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

    Control0..1*
    This element is affected by the following invariants: ele-1
    BindingFor example codes, see validation-processhttp://hl7.org/fhir/ValueSet/verificationresult-validation-process
    (example to http://hl7.org/fhir/ValueSet/verificationresult-validation-process)

    The primary process by which the target is validated.

    TypeCodeableConcept
    Must Supporttrue
    Summarytrue
    Invariantsele-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

    0. VerificationResult
    Definition

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

    ShortDescribes validation requirements, source(s), status and dates for one or more elements
    Control0..*
    Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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-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-6: A resource should have narrative for robust management (text.`div`.exists())
    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
    2. VerificationResult.id
    Definition

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

    ShortLogical id of this artifact
    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.

    Control0..1
    Typeid
    Summarytrue
    4. 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.

    ShortMetadata about the resource
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeMeta
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    6. 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.

    ShortA set of rules under which this content was created
    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.

    Control0..1
    This element is affected by the following invariants: ele-1
    Typeuri
    Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    8. VerificationResult.language
    Definition

    The base language in which the resource is written.

    ShortLanguage of the resource content
    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).

    Control0..1
    This element is affected by the following invariants: ele-1
    BindingThe codes SHOULD be taken from CommonLanguages
    (preferred to http://hl7.org/fhir/ValueSet/languages)

    A human language.

    Additional BindingsPurpose
    AllLanguagesMax Binding
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. 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.

    ShortText summary of the resource, for human interpretation
    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.

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeNarrative
    Alternate Namesnarrative, html, xhtml, display
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. 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.

    ShortContained, inline 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.

    Control0..*
    TypeResource
    Alternate Namesinline resources, anonymous resources, contained resources
    14. 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.

    ShortAdditional content defined by implementations
    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.

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension
    Standards StatusNormative (from Trial Use)
    Alternate Namesextensions, user content
    Invariantsele-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())
    SlicingThis element introduces a set of slices on VerificationResult.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 16. 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).

      ShortExtensions that cannot be ignored
      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.

      Control0..*
      This element is affected by the following invariants: ele-1
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
      Standards StatusNormative (from Trial Use)
      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 Namesextensions, user content
      Invariantsele-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())
      SlicingThis element introduces a set of slices on VerificationResult.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 18. VerificationResult.target
        Definition

        A resource that was validated.

        ShortA resource that was validated
        Comments

        References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

        Control1..1
        This element is affected by the following invariants: ele-1
        TypeReference(Single Nucleotide Polymorphism, Gene Fusion, Gene Expression, Variant Copy Number)
        Must Supporttrue
        Must Support TypesNo must-support rules about the choice of types/profiles
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
        20. VerificationResult.targetLocation
        Definition

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

        ShortThe fhirpath location(s) within the resource that was validated
        Comments

        Note that FHIR strings SHALL NOT exceed 1MB in size

        Control0..*
        This element is affected by the following invariants: ele-1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        22. VerificationResult.need
        Definition

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

        Shortnone | initial | periodic
        Comments

        Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

        Control0..1
        This element is affected by the following invariants: ele-1
        BindingThe codes SHOULD be taken from need
        (preferred to http://hl7.org/fhir/ValueSet/verificationresult-need)

        The frequency with which the target must be validated.

        TypeCodeableConcept
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        24. VerificationResult.status
        Definition

        Allows to indicate if the alteration has been validated or not by the validation method.

        ShortValidation status of the detected alteration (attested | validated | in-process | req-revalid | val-fail | reval-fail)
        Comments

        Note that FHIR strings SHALL NOT exceed 1MB in size

        Control1..1
        This element is affected by the following invariants: ele-1
        BindingThe codes SHALL be taken from status
        (required to http://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1)

        The validation status of the target.

        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        26. VerificationResult.statusDate
        Definition

        When the validation status was updated.

        ShortWhen the validation status was updated
        Control0..1
        This element is affected by the following invariants: ele-1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        28. VerificationResult.validationType
        Definition

        Validation method used (Experimental | By biologist | In silico).

        ShortType of validation of the detected alteration (Experimental | By biologist | In silico)
        Comments

        Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

        Control1..1
        This element is affected by the following invariants: ele-1
        BindingUnless not suitable, these codes SHALL be taken from Osiris Validation Type
        (extensible to https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/OsirisValidationType)
        TypeCodeableConcept
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        30. VerificationResult.validationProcess
        Definition

        Allows you to indicate a validation method (example: bibliographic)

        ShortValidation method
        Comments

        Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

        Control0..1
        This element is affected by the following invariants: ele-1
        BindingFor example codes, see validation-process
        (example to http://hl7.org/fhir/ValueSet/verificationresult-validation-process)

        The primary process by which the target is validated.

        TypeCodeableConcept
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        32. VerificationResult.frequency
        Definition

        Frequency of revalidation.

        ShortFrequency of revalidation
        Comments

        Describes the occurrence of an event that may occur multiple times. Timing schedules are used for specifying when events are expected or requested to occur, and may also be used to represent the summary of a past or ongoing event. For simplicity, the definitions of Timing components are expressed as 'future' events, but such components can also be used to describe historic or ongoing events.

        A Timing schedule can be a list of events and/or criteria for when the event happens, which can be expressed in a structured form and/or as a code. When both event and a repeating specification are provided, the list of events should be understood as an interpretation of the information in the repeat structure.

        Control0..1
        This element is affected by the following invariants: ele-1
        TypeTiming
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        34. VerificationResult.lastPerformed
        Definition

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

        ShortThe date/time validation was last completed (including failed validations)
        Control0..1
        This element is affected by the following invariants: ele-1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        36. VerificationResult.nextScheduled
        Definition

        The date when target is next validated, if appropriate.

        ShortThe date when target is next validated, if appropriate
        Control0..1
        This element is affected by the following invariants: ele-1
        Typedate
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        38. VerificationResult.failureAction
        Definition

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

        Shortfatal | warn | rec-only | none
        Comments

        Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

        Control0..1
        This element is affected by the following invariants: ele-1
        BindingThe codes SHOULD be taken from failure-action
        (preferred to http://hl7.org/fhir/ValueSet/verificationresult-failure-action)

        The result if validation fails.

        TypeCodeableConcept
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        40. VerificationResult.primarySource
        Definition

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

        ShortInformation about the primary source(s) involved in validation
        Control0..*
        This element is affected by the following invariants: ele-1
        TypeBackboneElement
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        42. 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.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        XML FormatIn the XML format, this property is represented as an attribute.
        44. 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.

        ShortAdditional content defined by implementations
        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.

        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension
        Standards StatusNormative (from Trial Use)
        Alternate Namesextensions, user content
        Invariantsele-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())
        SlicingThis element introduces a set of slices on VerificationResult.primarySource.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 46. 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).

          ShortExtensions that cannot be ignored even if unrecognized
          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.

          Control0..*
          This element is affected by the following invariants: ele-1
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
          Summarytrue
          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 Namesextensions, user content, modifiers
          Invariantsele-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.primarySource.who
          Definition

          Reference to the primary source.

          ShortReference to the primary source
          Comments

          References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

          Control0..1
          This element is affected by the following invariants: ele-1
          TypeReference(Organization, Practitioner, PractitionerRole)
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
          50. 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).

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

          Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

          Control0..*
          This element is affected by the following invariants: ele-1
          BindingFor example codes, see primary-source-type
          (example to http://hl7.org/fhir/ValueSet/verificationresult-primary-source-type)

          Type of the validation primary source.

          TypeCodeableConcept
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          52. VerificationResult.primarySource.communicationMethod
          Definition

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

          ShortMethod for exchanging information with the primary source
          Comments

          Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

          Control0..*
          This element is affected by the following invariants: ele-1
          BindingFor example codes, see verificationresult-communication-method
          (example to http://hl7.org/fhir/ValueSet/verificationresult-communication-method)

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

          TypeCodeableConcept
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          54. VerificationResult.primarySource.validationStatus
          Definition

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

          Shortsuccessful | failed | unknown
          Comments

          Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

          Control0..1
          This element is affected by the following invariants: ele-1
          BindingThe codes SHOULD be taken from validation-status
          (preferred to http://hl7.org/fhir/ValueSet/verificationresult-validation-status)

          Status of the validation of the target against the primary source.

          TypeCodeableConcept
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          56. VerificationResult.primarySource.validationDate
          Definition

          When the target was validated against the primary source.

          ShortWhen the target was validated against the primary source
          Control0..1
          This element is affected by the following invariants: ele-1
          TypedateTime
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          58. VerificationResult.primarySource.canPushUpdates
          Definition

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

          Shortyes | no | undetermined
          Comments

          Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

          Control0..1
          This element is affected by the following invariants: ele-1
          BindingThe codes SHOULD be taken from can-push-updates
          (preferred to http://hl7.org/fhir/ValueSet/verificationresult-can-push-updates)

          Ability of the primary source to push updates/alerts.

          TypeCodeableConcept
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          60. VerificationResult.primarySource.pushTypeAvailable
          Definition

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

          Shortspecific | any | source
          Comments

          Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

          Control0..*
          This element is affected by the following invariants: ele-1
          BindingThe codes SHOULD be taken from push-type-available
          (preferred to http://hl7.org/fhir/ValueSet/verificationresult-push-type-available)

          Type of alerts/updates the primary source can send.

          TypeCodeableConcept
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          62. VerificationResult.attestation
          Definition

          Information about the entity attesting to information.

          ShortInformation about the entity attesting to information
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeBackboneElement
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          64. 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.

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          XML FormatIn the XML format, this property is represented as an attribute.
          66. 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.

          ShortAdditional content defined by implementations
          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.

          Control0..*
          This element is affected by the following invariants: ele-1
          TypeExtension
          Standards StatusNormative (from Trial Use)
          Alternate Namesextensions, user content
          Invariantsele-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())
          SlicingThis element introduces a set of slices on VerificationResult.attestation.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 68. 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).

            ShortExtensions that cannot be ignored even if unrecognized
            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.

            Control0..*
            This element is affected by the following invariants: ele-1
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Summarytrue
            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 Namesextensions, user content, modifiers
            Invariantsele-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())
            70. VerificationResult.attestation.who
            Definition

            The individual or organization attesting to information.

            ShortThe individual or organization attesting to information
            Comments

            References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

            Control0..1
            This element is affected by the following invariants: ele-1
            TypeReference(Practitioner, PractitionerRole, Organization)
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
            72. VerificationResult.attestation.onBehalfOf
            Definition

            When the who is asserting on behalf of another (organization or individual).

            ShortWhen the who is asserting on behalf of another (organization or individual)
            Comments

            References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

            Control0..1
            This element is affected by the following invariants: ele-1
            TypeReference(Organization, Practitioner, PractitionerRole)
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
            74. VerificationResult.attestation.communicationMethod
            Definition

            The method by which attested information was submitted/retrieved (manual; API; Push).

            ShortThe method by which attested information was submitted/retrieved
            Comments

            Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

            Control0..1
            This element is affected by the following invariants: ele-1
            BindingFor example codes, see verificationresult-communication-method
            (example to http://hl7.org/fhir/ValueSet/verificationresult-communication-method)

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

            TypeCodeableConcept
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            76. VerificationResult.attestation.date
            Definition

            The date the information was attested to.

            ShortThe date the information was attested to
            Control0..1
            This element is affected by the following invariants: ele-1
            Typedate
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            78. VerificationResult.attestation.sourceIdentityCertificate
            Definition

            A digital identity certificate associated with the attestation source.

            ShortA digital identity certificate associated with the attestation source
            Comments

            Note that FHIR strings SHALL NOT exceed 1MB in size

            Control0..1
            This element is affected by the following invariants: ele-1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            80. VerificationResult.attestation.proxyIdentityCertificate
            Definition

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

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

            Note that FHIR strings SHALL NOT exceed 1MB in size

            Control0..1
            This element is affected by the following invariants: ele-1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            82. 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.

            ShortProxy signature
            Comments

            The elements of the Signature Resource are for ease of access of these elements. For digital signatures (Xml DigSig, JWS), the non-repudiation proof comes from the Signature validation, which includes validation of the referenced objects (e.g. Resources) (a.k.a., Content) in the XML-Signature Detached form.

            Control0..1
            This element is affected by the following invariants: ele-1
            TypeSignature
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            84. VerificationResult.attestation.sourceSignature
            Definition

            Signed assertion by the attestation source that they have attested to the information.

            ShortAttester signature
            Comments

            The elements of the Signature Resource are for ease of access of these elements. For digital signatures (Xml DigSig, JWS), the non-repudiation proof comes from the Signature validation, which includes validation of the referenced objects (e.g. Resources) (a.k.a., Content) in the XML-Signature Detached form.

            Control0..1
            This element is affected by the following invariants: ele-1
            TypeSignature
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            86. VerificationResult.validator
            Definition

            Information about the entity validating information.

            ShortInformation about the entity validating information
            Control0..*
            This element is affected by the following invariants: ele-1
            TypeBackboneElement
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            88. 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.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            XML FormatIn the XML format, this property is represented as an attribute.
            90. 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.

            ShortAdditional content defined by implementations
            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.

            Control0..*
            This element is affected by the following invariants: ele-1
            TypeExtension
            Standards StatusNormative (from Trial Use)
            Alternate Namesextensions, user content
            Invariantsele-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())
            SlicingThis element introduces a set of slices on VerificationResult.validator.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 92. 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).

              ShortExtensions that cannot be ignored even if unrecognized
              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.

              Control0..*
              This element is affected by the following invariants: ele-1
              TypeExtension
              Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
              Summarytrue
              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 Namesextensions, user content, modifiers
              Invariantsele-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())
              94. VerificationResult.validator.organization
              Definition

              Reference to the organization validating information.

              ShortReference to the organization validating information
              Comments

              References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

              Control1..1
              This element is affected by the following invariants: ele-1
              TypeReference(Organization)
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
              96. VerificationResult.validator.identityCertificate
              Definition

              A digital identity certificate associated with the validator.

              ShortA digital identity certificate associated with the validator
              Comments

              Note that FHIR strings SHALL NOT exceed 1MB in size

              Control0..1
              This element is affected by the following invariants: ele-1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              98. VerificationResult.validator.attestationSignature
              Definition

              Signed assertion by the validator that they have validated the information.

              ShortValidator signature
              Comments

              The elements of the Signature Resource are for ease of access of these elements. For digital signatures (Xml DigSig, JWS), the non-repudiation proof comes from the Signature validation, which includes validation of the referenced objects (e.g. Resources) (a.k.a., Content) in the XML-Signature Detached form.

              Control0..1
              This element is affected by the following invariants: ele-1
              TypeSignature
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))