FHIR Osiris Implementation Guide
2.1.0 - ci-build
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
| Official URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/data-validation | Version: 2.1.0 | |||
| Draft as of 2024-03-21 | Computable Name: DataValidation | |||
Validation information about data from a Variant / Expression / Fusion / CopyNumber profile.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from VerificationResult
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  VerificationResult | 0..* | VerificationResult | Describes validation requirements, source(s), status and dates for one or more elements | |
  target | S | 1..1 | Reference(Single Nucleotide Polymorphism | Gene Fusion | Gene Expression | Variant Copy Number) | A resource that was validated |
 status | S | 1..1 | code | Validation status of the detected alteration (attested | validated | in-process | req-revalid | val-fail | reval-fail) |
| validationType | S | 1..1 | CodeableConcept | Type of validation of the detected alteration (Experimental | By biologist | In silico) Binding: Osiris Validation Type (extensible) |
 validationProcess | S | 0..1 | CodeableConcept | Validation method |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| VerificationResult.validationType | extensible | OsirisValidationTypehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/OsirisValidationTypefrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| VerificationResult | 0..* | VerificationResult | Describes validation requirements, source(s), status and dates for one or more elements | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| target | SΣC | 1..1 | Reference(Single Nucleotide Polymorphism | Gene Fusion | Gene Expression | Variant Copy Number) | A resource that was validated ref-1: SHALL have a contained resource if a local reference is provided |
| status | SΣ | 1..1 | code | Validation status of the detected alteration (attested | validated | in-process | req-revalid | val-fail | reval-fail) Binding: status (required): The validation status of the target. |
 validationType | SΣ | 1..1 | CodeableConcept | Type of validation of the detected alteration (Experimental | By biologist | In silico) Binding: Osiris Validation Type (extensible) |
| validationProcess | SΣ | 0..1 | CodeableConcept | Validation method Binding: validation-process (example): The primary process by which the target is validated. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| VerificationResult.status | required | statushttp://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1from the FHIR Standard | |
| VerificationResult.validationType | extensible | OsirisValidationTypehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/OsirisValidationTypefrom this IG | |
| VerificationResult.validationProcess | example | validation-processhttp://hl7.org/fhir/ValueSet/verificationresult-validation-processfrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| VerificationResult | 0..* | VerificationResult | Describes validation requirements, source(s), status and dates for one or more elements | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| target | SΣC | 1..1 | Reference(Single Nucleotide Polymorphism | Gene Fusion | Gene Expression | Variant Copy Number) | A resource that was validated ref-1: SHALL have a contained resource if a local reference is provided | ||||
| targetLocation | Σ | 0..* | string | The fhirpath location(s) within the resource that was validated | ||||
| need | Σ | 0..1 | CodeableConcept | none | initial | periodic Binding: need (preferred): The frequency with which the target must be validated. | ||||
| status | SΣ | 1..1 | code | Validation status of the detected alteration (attested | validated | in-process | req-revalid | val-fail | reval-fail) Binding: status (required): The validation status of the target. | ||||
| statusDate | Σ | 0..1 | dateTime | When the validation status was updated | ||||
| validationType | SΣ | 1..1 | CodeableConcept | Type of validation of the detected alteration (Experimental | By biologist | In silico) Binding: Osiris Validation Type (extensible) | ||||
| validationProcess | SΣ | 0..1 | CodeableConcept | Validation method Binding: validation-process (example): The primary process by which the target is validated. | ||||
| frequency | 0..1 | Timing | Frequency of revalidation | |||||
| lastPerformed | 0..1 | dateTime | The date/time validation was last completed (including failed validations) | |||||
| nextScheduled | 0..1 | date | The date when target is next validated, if appropriate | |||||
| failureAction | Σ | 0..1 | CodeableConcept | fatal | warn | rec-only | none Binding: failure-action (preferred): The result if validation fails. | ||||
 primarySource | 0..* | BackboneElement | Information about the primary source(s) involved in validation | |||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| who | C | 0..1 | Reference(Organization | Practitioner | PractitionerRole) | Reference to the primary source ref-1: SHALL have a contained resource if a local reference is provided | ||||
| type | Σ | 0..* | CodeableConcept | Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source) Binding: primary-source-type (example): Type of the validation primary source. | ||||
| communicationMethod | Σ | 0..* | CodeableConcept | Method for exchanging information with the primary source Binding: verificationresult-communication-method (example): Method for communicating with the data source (manual; API; Push). | ||||
| validationStatus | 0..1 | CodeableConcept | successful | failed | unknown Binding: validation-status (preferred): Status of the validation of the target against the primary source. | |||||
| validationDate | 0..1 | dateTime | When the target was validated against the primary source | |||||
| canPushUpdates | Σ | 0..1 | CodeableConcept | yes | no | undetermined Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts. | ||||
| pushTypeAvailable | 0..* | CodeableConcept | specific | any | source Binding: push-type-available (preferred): Type of alerts/updates the primary source can send. | |||||
| attestation | 0..1 | BackboneElement | Information about the entity attesting to information | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| who | ΣC | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | The individual or organization attesting to information ref-1: SHALL have a contained resource if a local reference is provided | ||||
| onBehalfOf | ΣC | 0..1 | Reference(Organization | Practitioner | PractitionerRole) | When the who is asserting on behalf of another (organization or individual) ref-1: SHALL have a contained resource if a local reference is provided | ||||
| communicationMethod | Σ | 0..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: verificationresult-communication-method (example): Method for communicating with the data source (manual; API; Push). | ||||
| date | Σ | 0..1 | date | The date the information was attested to | ||||
| sourceIdentityCertificate | 0..1 | string | A digital identity certificate associated with the attestation source | |||||
| proxyIdentityCertificate | 0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source | |||||
| proxySignature | 0..1 | Signature | Proxy signature | |||||
| sourceSignature | 0..1 | Signature | Attester signature | |||||
 validator | 0..* | BackboneElement | Information about the entity validating information | |||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| organization | C | 1..1 | Reference(Organization) | Reference to the organization validating information ref-1: SHALL have a contained resource if a local reference is provided | ||||
| identityCertificate | 0..1 | string | A digital identity certificate associated with the validator | |||||
| attestationSignature | 0..1 | Signature | Validator signature | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| VerificationResult.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| VerificationResult.need | preferred | needhttp://hl7.org/fhir/ValueSet/verificationresult-needfrom the FHIR Standard | ||||
| VerificationResult.status | required | statushttp://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1from the FHIR Standard | ||||
| VerificationResult.validationType | extensible | OsirisValidationTypehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/OsirisValidationTypefrom this IG | ||||
| VerificationResult.validationProcess | example | validation-processhttp://hl7.org/fhir/ValueSet/verificationresult-validation-processfrom the FHIR Standard | ||||
| VerificationResult.failureAction | preferred | failure-actionhttp://hl7.org/fhir/ValueSet/verificationresult-failure-actionfrom the FHIR Standard | ||||
| VerificationResult.primarySource.type | example | primary-source-typehttp://hl7.org/fhir/ValueSet/verificationresult-primary-source-typefrom the FHIR Standard | ||||
| VerificationResult.primarySource.communicationMethod | example | verificationresult-communication-methodhttp://hl7.org/fhir/ValueSet/verificationresult-communication-methodfrom the FHIR Standard | ||||
| VerificationResult.primarySource.validationStatus | preferred | validation-statushttp://hl7.org/fhir/ValueSet/verificationresult-validation-statusfrom the FHIR Standard | ||||
| VerificationResult.primarySource.canPushUpdates | preferred | can-push-updateshttp://hl7.org/fhir/ValueSet/verificationresult-can-push-updatesfrom the FHIR Standard | ||||
| VerificationResult.primarySource.pushTypeAvailable | preferred | push-type-availablehttp://hl7.org/fhir/ValueSet/verificationresult-push-type-availablefrom the FHIR Standard | ||||
| VerificationResult.attestation.communicationMethod | example | verificationresult-communication-methodhttp://hl7.org/fhir/ValueSet/verificationresult-communication-methodfrom the FHIR Standard |
This structure is derived from VerificationResult
Summary
Mandatory: 2 elements
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from VerificationResult
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| VerificationResult | 0..* | VerificationResult | Describes validation requirements, source(s), status and dates for one or more elements | |
| target | S | 1..1 | Reference(Single Nucleotide Polymorphism | Gene Fusion | Gene Expression | Variant Copy Number) | A resource that was validated |
| status | S | 1..1 | code | Validation status of the detected alteration (attested | validated | in-process | req-revalid | val-fail | reval-fail) |
| validationType | S | 1..1 | CodeableConcept | Type of validation of the detected alteration (Experimental | By biologist | In silico) Binding: Osiris Validation Type (extensible) |
| validationProcess | S | 0..1 | CodeableConcept | Validation method |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| VerificationResult.validationType | extensible | OsirisValidationTypehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/OsirisValidationTypefrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| VerificationResult | 0..* | VerificationResult | Describes validation requirements, source(s), status and dates for one or more elements | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| target | SΣC | 1..1 | Reference(Single Nucleotide Polymorphism | Gene Fusion | Gene Expression | Variant Copy Number) | A resource that was validated ref-1: SHALL have a contained resource if a local reference is provided |
| status | SΣ | 1..1 | code | Validation status of the detected alteration (attested | validated | in-process | req-revalid | val-fail | reval-fail) Binding: status (required): The validation status of the target. |
| validationType | SΣ | 1..1 | CodeableConcept | Type of validation of the detected alteration (Experimental | By biologist | In silico) Binding: Osiris Validation Type (extensible) |
| validationProcess | SΣ | 0..1 | CodeableConcept | Validation method Binding: validation-process (example): The primary process by which the target is validated. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| VerificationResult.status | required | statushttp://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1from the FHIR Standard | |
| VerificationResult.validationType | extensible | OsirisValidationTypehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/OsirisValidationTypefrom this IG | |
| VerificationResult.validationProcess | example | validation-processhttp://hl7.org/fhir/ValueSet/verificationresult-validation-processfrom the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| VerificationResult | 0..* | VerificationResult | Describes validation requirements, source(s), status and dates for one or more elements | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| target | SΣC | 1..1 | Reference(Single Nucleotide Polymorphism | Gene Fusion | Gene Expression | Variant Copy Number) | A resource that was validated ref-1: SHALL have a contained resource if a local reference is provided | ||||
| targetLocation | Σ | 0..* | string | The fhirpath location(s) within the resource that was validated | ||||
| need | Σ | 0..1 | CodeableConcept | none | initial | periodic Binding: need (preferred): The frequency with which the target must be validated. | ||||
| status | SΣ | 1..1 | code | Validation status of the detected alteration (attested | validated | in-process | req-revalid | val-fail | reval-fail) Binding: status (required): The validation status of the target. | ||||
| statusDate | Σ | 0..1 | dateTime | When the validation status was updated | ||||
| validationType | SΣ | 1..1 | CodeableConcept | Type of validation of the detected alteration (Experimental | By biologist | In silico) Binding: Osiris Validation Type (extensible) | ||||
| validationProcess | SΣ | 0..1 | CodeableConcept | Validation method Binding: validation-process (example): The primary process by which the target is validated. | ||||
| frequency | 0..1 | Timing | Frequency of revalidation | |||||
| lastPerformed | 0..1 | dateTime | The date/time validation was last completed (including failed validations) | |||||
| nextScheduled | 0..1 | date | The date when target is next validated, if appropriate | |||||
| failureAction | Σ | 0..1 | CodeableConcept | fatal | warn | rec-only | none Binding: failure-action (preferred): The result if validation fails. | ||||
| primarySource | 0..* | BackboneElement | Information about the primary source(s) involved in validation | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| who | C | 0..1 | Reference(Organization | Practitioner | PractitionerRole) | Reference to the primary source ref-1: SHALL have a contained resource if a local reference is provided | ||||
| type | Σ | 0..* | CodeableConcept | Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source) Binding: primary-source-type (example): Type of the validation primary source. | ||||
| communicationMethod | Σ | 0..* | CodeableConcept | Method for exchanging information with the primary source Binding: verificationresult-communication-method (example): Method for communicating with the data source (manual; API; Push). | ||||
| validationStatus | 0..1 | CodeableConcept | successful | failed | unknown Binding: validation-status (preferred): Status of the validation of the target against the primary source. | |||||
| validationDate | 0..1 | dateTime | When the target was validated against the primary source | |||||
| canPushUpdates | Σ | 0..1 | CodeableConcept | yes | no | undetermined Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts. | ||||
| pushTypeAvailable | 0..* | CodeableConcept | specific | any | source Binding: push-type-available (preferred): Type of alerts/updates the primary source can send. | |||||
| attestation | 0..1 | BackboneElement | Information about the entity attesting to information | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| who | ΣC | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | The individual or organization attesting to information ref-1: SHALL have a contained resource if a local reference is provided | ||||
| onBehalfOf | ΣC | 0..1 | Reference(Organization | Practitioner | PractitionerRole) | When the who is asserting on behalf of another (organization or individual) ref-1: SHALL have a contained resource if a local reference is provided | ||||
| communicationMethod | Σ | 0..1 | CodeableConcept | The method by which attested information was submitted/retrieved Binding: verificationresult-communication-method (example): Method for communicating with the data source (manual; API; Push). | ||||
| date | Σ | 0..1 | date | The date the information was attested to | ||||
| sourceIdentityCertificate | 0..1 | string | A digital identity certificate associated with the attestation source | |||||
| proxyIdentityCertificate | 0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source | |||||
| proxySignature | 0..1 | Signature | Proxy signature | |||||
| sourceSignature | 0..1 | Signature | Attester signature | |||||
| validator | 0..* | BackboneElement | Information about the entity validating information | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| organization | C | 1..1 | Reference(Organization) | Reference to the organization validating information ref-1: SHALL have a contained resource if a local reference is provided | ||||
| identityCertificate | 0..1 | string | A digital identity certificate associated with the validator | |||||
| attestationSignature | 0..1 | Signature | Validator signature | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| VerificationResult.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| VerificationResult.need | preferred | needhttp://hl7.org/fhir/ValueSet/verificationresult-needfrom the FHIR Standard | ||||
| VerificationResult.status | required | statushttp://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1from the FHIR Standard | ||||
| VerificationResult.validationType | extensible | OsirisValidationTypehttps://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/OsirisValidationTypefrom this IG | ||||
| VerificationResult.validationProcess | example | validation-processhttp://hl7.org/fhir/ValueSet/verificationresult-validation-processfrom the FHIR Standard | ||||
| VerificationResult.failureAction | preferred | failure-actionhttp://hl7.org/fhir/ValueSet/verificationresult-failure-actionfrom the FHIR Standard | ||||
| VerificationResult.primarySource.type | example | primary-source-typehttp://hl7.org/fhir/ValueSet/verificationresult-primary-source-typefrom the FHIR Standard | ||||
| VerificationResult.primarySource.communicationMethod | example | verificationresult-communication-methodhttp://hl7.org/fhir/ValueSet/verificationresult-communication-methodfrom the FHIR Standard | ||||
| VerificationResult.primarySource.validationStatus | preferred | validation-statushttp://hl7.org/fhir/ValueSet/verificationresult-validation-statusfrom the FHIR Standard | ||||
| VerificationResult.primarySource.canPushUpdates | preferred | can-push-updateshttp://hl7.org/fhir/ValueSet/verificationresult-can-push-updatesfrom the FHIR Standard | ||||
| VerificationResult.primarySource.pushTypeAvailable | preferred | push-type-availablehttp://hl7.org/fhir/ValueSet/verificationresult-push-type-availablefrom the FHIR Standard | ||||
| VerificationResult.attestation.communicationMethod | example | verificationresult-communication-methodhttp://hl7.org/fhir/ValueSet/verificationresult-communication-methodfrom the FHIR Standard |
This structure is derived from VerificationResult
Summary
Mandatory: 2 elements
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ Arkhn. Package arkhn.fhir.uv.osiris#2.1.0 based on FHIR 4.0.1. Generated 2024-03-21
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change