National Directory of Healthcare Providers & Services (NDH) Implementation Guide, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ndh/ and changes regularly. See the Directory of published versions
Active as of 2023-01-22 |
Definitions for the ndh-Verification resource profile.
Guidance on how to interpret the contents of this table can be found here
0. VerificationResult | |
Definition | Describes Verification requirements, source(s), status and dates for one or more elements |
Short | Verification |
2. VerificationResult.target | |
Short | The resource instance was verified or attested |
Control | 1..? |
Must Support | true |
4. VerificationResult.targetLocation | |
Short | The fhirpath location(s) within the resource instance that was verified or attested |
Must Support | true |
6. VerificationResult.need | |
Control | 1..? |
Must Support | true |
8. VerificationResult.status | |
Must Support | true |
10. VerificationResult.statusDate | |
Control | 1..? |
Must Support | true |
12. VerificationResult.validationType | |
Short | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing |
Control | 1..? |
Binding | The codes SHALL be taken from validation-type (required to http://hl7.org/fhir/ValueSet/verificationresult-validation-type ) |
Must Support | true |
14. VerificationResult.validationProcess | |
Short | The process(es) by which the target was verified |
Control | 1..? |
Binding | Unless not suitable, these codes SHALL be taken from NDH Verification Process Value Set (extensible to http://hl7.org/fhir/us/ndh/ValueSet/NdhVerificationProcessVS ) |
Must Support | true |
16. VerificationResult.frequency | |
Short | Frequency of verification |
Must Support | true |
18. VerificationResult.lastPerformed | |
Short | The date/time verification was last completed (including failed verifications) |
Must Support | true |
20. VerificationResult.nextScheduled | |
Short | The date when target is next verified, if appropriate |
Must Support | true |
22. VerificationResult.failureAction | |
Control | 1..? |
Must Support | true |
24. VerificationResult.primarySource | |
Must Support | true |
26. VerificationResult.primarySource.who | |
Type | Reference(NDH Base Organization Profile, NDH Base Practitioner Profile, NDH Base PractitionerRole) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
28. VerificationResult.primarySource.type | |
Definition | Type of primary source |
Control | 1..? |
Binding | Unless not suitable, these codes SHALL be taken from primary-source-type (extensible to http://hl7.org/fhir/ValueSet/verificationresult-primary-source-type ) |
Must Support | true |
30. VerificationResult.primarySource.communicationMethod | |
Binding | Unless not suitable, these codes SHALL be taken from VerificationResult Communication Method (extensible to http://terminology.hl7.org/ValueSet/verificationresult-communication-method ) |
Must Support | true |
32. VerificationResult.primarySource.validationStatus | |
Must Support | true |
34. VerificationResult.primarySource.validationDate | |
Must Support | true |
36. VerificationResult.primarySource.canPushUpdates | |
Must Support | true |
38. VerificationResult.primarySource.pushTypeAvailable | |
Must Support | true |
40. VerificationResult.attestation | |
Control | 1..? |
Must Support | true |
42. VerificationResult.attestation.who | |
Control | 1..? |
Type | Reference(NDH Base Organization Profile, NDH Base Practitioner Profile, NDH Base PractitionerRole) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
44. VerificationResult.attestation.onBehalfOf | |
Type | Reference(NDH Base Organization Profile, NDH Base Practitioner Profile, NDH Base PractitionerRole) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
46. VerificationResult.attestation.communicationMethod | |
Control | 1..? |
Binding | Unless not suitable, these codes SHALL be taken from VerificationResult Communication Method (extensible to http://terminology.hl7.org/ValueSet/verificationresult-communication-method ) |
Must Support | true |
48. VerificationResult.attestation.date | |
Control | 1..? |
Must Support | true |
50. VerificationResult.attestation.sourceIdentityCertificate | |
Must Support | true |
52. VerificationResult.attestation.proxyIdentityCertificate | |
Must Support | true |
54. VerificationResult.attestation.proxySignature | |
Must Support | true |
56. VerificationResult.attestation.sourceSignature | |
Must Support | true |
58. VerificationResult.validator | |
Must Support | true |
60. VerificationResult.validator.organization | |
Type | Reference(NDH Base Organization Profile) |
Must Support | true |
62. VerificationResult.validator.identityCertificate | |
Must Support | true |
64. VerificationResult.validator.attestationSignature | |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here
0. VerificationResult | |
Definition | Describes Verification requirements, source(s), status and dates for one or more elements Describes validation requirements, source(s), status and dates for one or more elements. |
Short | VerificationDescribes validation requirements, source(s), status and dates for one or more elements |
Control | 0..* |
Is Modifier | false |
Summary | false |
Invariants | 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. |
Short | A 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. |
Control | 0..1 |
Type | uri |
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Invariants | ele-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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
Summary | false |
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 |
Invariants | 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()) |
6. VerificationResult.target | |
Definition | A resource that was validated. |
Short | The resource instance was verified or attestedA resource that was validated |
Control | 10..* |
Type | Reference(Resource) |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
8. VerificationResult.targetLocation | |
Definition | The fhirpath location(s) within the resource that was validated. |
Short | The fhirpath location(s) within the resource instance that was verified or attestedThe fhirpath location(s) within the resource that was validated |
Control | 0..* |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
10. VerificationResult.need | |
Definition | The frequency with which the target must be validated (none; initial; periodic). |
Short | none | initial | periodic |
Control | 10..1 |
Binding | The codes SHOULD be taken from needhttp://hl7.org/fhir/ValueSet/verificationresult-need (preferred to http://hl7.org/fhir/ValueSet/verificationresult-need )The frequency with which the target must be validated. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
12. VerificationResult.status | |
Definition | The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed). |
Short | attested | validated | in-process | req-revalid | val-fail | reval-fail |
Control | 1..1 |
Binding | The 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. |
Type | code |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | 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. |
Short | When the validation status was updated |
Control | 10..1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
16. VerificationResult.validationType | |
Definition | What the target is validated against (nothing; primary source; multiple sources). |
Short | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothingnothing | primary | multiple |
Control | 10..1 |
Binding | The codes SHALL be taken from The codes SHOULD be taken from validation-typehttp://hl7.org/fhir/ValueSet/verificationresult-validation-type (required to http://hl7.org/fhir/ValueSet/verificationresult-validation-type ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
18. VerificationResult.validationProcess | |
Definition | The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context). |
Short | The process(es) by which the target was verifiedThe primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context) |
Control | 10..* |
Binding | Unless not suitable, these codes SHALL be taken from For example codes, see NDH Verification Process Value Sethttp://hl7.org/fhir/ValueSet/verificationresult-validation-process (extensible to http://hl7.org/fhir/us/ndh/ValueSet/NdhVerificationProcessVS ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
20. VerificationResult.frequency | |
Definition | Frequency of revalidation. |
Short | Frequency of verificationFrequency of revalidation |
Control | 0..1 |
Type | Timing |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
22. VerificationResult.lastPerformed | |
Definition | The date/time validation was last completed (including failed validations). |
Short | The date/time verification was last completed (including failed verifications)The date/time validation was last completed (including failed validations) |
Control | 0..1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
24. VerificationResult.nextScheduled | |
Definition | The date when target is next validated, if appropriate. |
Short | The date when target is next verified, if appropriateThe date when target is next validated, if appropriate |
Control | 0..1 |
Type | date |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
26. VerificationResult.failureAction | |
Definition | The result if validation fails (fatal; warning; record only; none). |
Short | fatal | warn | rec-only | none |
Control | 10..1 |
Binding | The codes SHOULD be taken from failure-actionhttp://hl7.org/fhir/ValueSet/verificationresult-failure-action (preferred to http://hl7.org/fhir/ValueSet/verificationresult-failure-action )The result if validation fails. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
28. VerificationResult.primarySource | |
Definition | Information about the primary source(s) involved in validation. |
Short | Information about the primary source(s) involved in validation |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
30. 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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | 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 |
Invariants | 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()) |
32. VerificationResult.primarySource.who | |
Definition | Reference to the primary source. |
Short | Reference to the primary source |
Control | 0..1 |
Type | Reference(NDH Base Organization Profile, NDH Base Practitioner Profile, NDH Base PractitionerRole, Organization, Practitioner, PractitionerRole) |
Is Modifier | false |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
34. 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). |
Short | 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 | Unless not suitable, these codes SHALL be taken from For example codes, see primary-source-typehttp://hl7.org/fhir/ValueSet/verificationresult-primary-source-type (extensible to http://hl7.org/fhir/ValueSet/verificationresult-primary-source-type ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
36. VerificationResult.primarySource.communicationMethod | |
Definition | Method for communicating with the primary source (manual; API; Push). |
Short | Method for exchanging information with the primary source |
Control | 0..* |
Binding | Unless not suitable, these codes SHALL be taken from For example codes, see VerificationResult Communication Methodhttp://hl7.org/fhir/ValueSet/verificationresult-communication-method (extensible to http://terminology.hl7.org/ValueSet/verificationresult-communication-method ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
38. VerificationResult.primarySource.validationStatus | |
Definition | Status of the validation of the target against the primary source (successful; failed; unknown). |
Short | successful | failed | unknown |
Control | 0..1 |
Binding | The codes SHOULD be taken from validation-statushttp://hl7.org/fhir/ValueSet/verificationresult-validation-status (preferred to http://hl7.org/fhir/ValueSet/verificationresult-validation-status )Status of the validation of the target against the primary source. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
40. VerificationResult.primarySource.validationDate | |
Definition | When the target was validated against the primary source. |
Short | When the target was validated against the primary source |
Control | 0..1 |
Type | dateTime |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
42. VerificationResult.primarySource.canPushUpdates | |
Definition | Ability of the primary source to push updates/alerts (yes; no; undetermined). |
Short | yes | no | undetermined |
Control | 0..1 |
Binding | The codes SHOULD be taken from can-push-updateshttp://hl7.org/fhir/ValueSet/verificationresult-can-push-updates (preferred to http://hl7.org/fhir/ValueSet/verificationresult-can-push-updates )Ability of the primary source to push updates/alerts. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
44. VerificationResult.primarySource.pushTypeAvailable | |
Definition | Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source). |
Short | specific | any | source |
Control | 0..* |
Binding | The codes SHOULD be taken from push-type-availablehttp://hl7.org/fhir/ValueSet/verificationresult-push-type-available (preferred to http://hl7.org/fhir/ValueSet/verificationresult-push-type-available )Type of alerts/updates the primary source can send. |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
46. VerificationResult.attestation | |
Definition | Information about the entity attesting to information. |
Short | Information about the entity attesting to information |
Control | 10..1 |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
48. 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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | 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 |
Invariants | 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()) |
50. VerificationResult.attestation.who | |
Definition | The individual or organization attesting to information. |
Short | The individual or organization attesting to information |
Control | 10..1 |
Type | Reference(NDH Base Organization Profile, NDH Base Practitioner Profile, NDH Base PractitionerRole, Practitioner, PractitionerRole, Organization) |
Is Modifier | false |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
52. VerificationResult.attestation.onBehalfOf | |
Definition | When the who is asserting on behalf of another (organization or individual). |
Short | When the who is asserting on behalf of another (organization or individual) |
Control | 0..1 |
Type | Reference(NDH Base Organization Profile, NDH Base Practitioner Profile, NDH Base PractitionerRole, Organization, Practitioner, PractitionerRole) |
Is Modifier | false |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
54. VerificationResult.attestation.communicationMethod | |
Definition | The method by which attested information was submitted/retrieved (manual; API; Push). |
Short | The method by which attested information was submitted/retrieved |
Control | 10..1 |
Binding | Unless not suitable, these codes SHALL be taken from For example codes, see VerificationResult Communication Methodhttp://hl7.org/fhir/ValueSet/verificationresult-communication-method (extensible to http://terminology.hl7.org/ValueSet/verificationresult-communication-method ) |
Type | CodeableConcept |
Is Modifier | false |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
56. VerificationResult.attestation.date | |
Definition | The date the information was attested to. |
Short | The date the information was attested to |
Control | 10..1 |
Type | date |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | true |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
58. VerificationResult.attestation.sourceIdentityCertificate | |
Definition | A digital identity certificate associated with the attestation source. |
Short | A digital identity certificate associated with the attestation source |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
60. VerificationResult.attestation.proxyIdentityCertificate | |
Definition | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source. |
Short | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
62. 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. |
Short | Proxy signature |
Control | 0..1 |
Type | Signature |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
64. VerificationResult.attestation.sourceSignature | |
Definition | Signed assertion by the attestation source that they have attested to the information. |
Short | Attester signature |
Control | 0..1 |
Type | Signature |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
66. VerificationResult.validator | |
Definition | Information about the entity validating information. |
Short | Information about the entity validating information |
Control | 0..* |
Type | BackboneElement |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
68. 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). |
Short | Extensions 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | 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 |
Invariants | 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()) |
70. VerificationResult.validator.organization | |
Definition | Reference to the organization validating information. |
Short | Reference to the organization validating information |
Control | 1..1 |
Type | Reference(NDH Base Organization Profile, Organization) |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
72. VerificationResult.validator.identityCertificate | |
Definition | A digital identity certificate associated with the validator. |
Short | A digital identity certificate associated with the validator |
Control | 0..1 |
Type | string |
Is Modifier | false |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Must Support | true |
Summary | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
74. VerificationResult.validator.attestationSignature | |
Definition | Signed assertion by the validator that they have validated the information. |
Short | Validator signature |
Control | 0..1 |
Type | Signature |
Is Modifier | false |
Must Support | true |
Summary | false |
Invariants | 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
0. VerificationResult | |||||
Definition | Describes Verification requirements, source(s), status and dates for one or more elements | ||||
Short | Verification | ||||
Control | 0..* | ||||
Is Modifier | false | ||||
Summary | false | ||||
Invariants | 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.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Short | Logical 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. | ||||
Control | 0..1 | ||||
Type | id | ||||
Is Modifier | false | ||||
Summary | true | ||||
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. | ||||
Short | Metadata about the resource | ||||
Control | 0..1 | ||||
Type | Meta | ||||
Is Modifier | false | ||||
Summary | true | ||||
Invariants | ele-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. | ||||
Short | A 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. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true 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 Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Invariants | ele-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. | ||||
Short | Language 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). | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | ele-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. | ||||
Short | Text 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. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | narrative, html, xhtml, display | ||||
Invariants | ele-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. | ||||
Short | Contained, 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. | ||||
Control | 0..* | ||||
Type | Resource | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | inline 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. | ||||
Short | Additional 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | 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() ) | ||||
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). | ||||
Short | Extensions 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
Summary | false | ||||
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 | ||||
Invariants | 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() ) | ||||
18. VerificationResult.target | |||||
Definition | A resource that was validated. | ||||
Short | The resource instance was verified or attested | ||||
Control | 1..* | ||||
Type | Reference(Resource) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
20. VerificationResult.targetLocation | |||||
Definition | The fhirpath location(s) within the resource that was validated. | ||||
Short | The fhirpath location(s) within the resource instance that was verified or attested | ||||
Control | 0..* | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-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). | ||||
Short | none | initial | periodic | ||||
Control | 1..1 | ||||
Binding | The codes SHOULD be taken from need (preferred to http://hl7.org/fhir/ValueSet/verificationresult-need )The frequency with which the target must be validated. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
24. VerificationResult.status | |||||
Definition | The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed). | ||||
Short | attested | validated | in-process | req-revalid | val-fail | reval-fail | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from status (required to http://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1 )The validation status of the target. | ||||
Type | code | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-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. | ||||
Short | When the validation status was updated | ||||
Control | 1..1 | ||||
Type | dateTime | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
28. VerificationResult.validationType | |||||
Definition | What the target is validated against (nothing; primary source; multiple sources). | ||||
Short | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing | ||||
Control | 1..1 | ||||
Binding | The codes SHALL be taken from validation-type (required to http://hl7.org/fhir/ValueSet/verificationresult-validation-type ) | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
30. VerificationResult.validationProcess | |||||
Definition | The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context). | ||||
Short | The process(es) by which the target was verified | ||||
Control | 1..* | ||||
Binding | Unless not suitable, these codes SHALL be taken from NDH Verification Process Value Set (extensible to http://hl7.org/fhir/us/ndh/ValueSet/NdhVerificationProcessVS ) | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
32. VerificationResult.frequency | |||||
Definition | Frequency of revalidation. | ||||
Short | Frequency of verification | ||||
Control | 0..1 | ||||
Type | Timing | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-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). | ||||
Short | The date/time verification was last completed (including failed verifications) | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-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. | ||||
Short | The date when target is next verified, if appropriate | ||||
Control | 0..1 | ||||
Type | date | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-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). | ||||
Short | fatal | warn | rec-only | none | ||||
Control | 1..1 | ||||
Binding | The codes SHOULD be taken from failure-action (preferred to http://hl7.org/fhir/ValueSet/verificationresult-failure-action )The result if validation fails. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-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. | ||||
Short | Information about the primary source(s) involved in validation | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-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. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
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. | ||||
Short | Additional 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | 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() ) | ||||
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). | ||||
Short | Extensions 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | 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 | ||||
Invariants | 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.primarySource.who | |||||
Definition | Reference to the primary source. | ||||
Short | Reference to the primary source | ||||
Control | 0..1 | ||||
Type | Reference(NDH Base Organization Profile, NDH Base Practitioner Profile, NDH Base PractitionerRole) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
50. VerificationResult.primarySource.type | |||||
Definition | Type of primary source | ||||
Short | Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source) | ||||
Control | 1..* | ||||
Binding | Unless not suitable, these codes SHALL be taken from primary-source-type (extensible to http://hl7.org/fhir/ValueSet/verificationresult-primary-source-type ) | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-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). | ||||
Short | Method for exchanging information with the primary source | ||||
Control | 0..* | ||||
Binding | Unless not suitable, these codes SHALL be taken from VerificationResult Communication Method (extensible to http://terminology.hl7.org/ValueSet/verificationresult-communication-method ) | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-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). | ||||
Short | successful | failed | unknown | ||||
Control | 0..1 | ||||
Binding | The 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. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-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. | ||||
Short | When the target was validated against the primary source | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-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). | ||||
Short | yes | no | undetermined | ||||
Control | 0..1 | ||||
Binding | The 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. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-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). | ||||
Short | specific | any | source | ||||
Control | 0..* | ||||
Binding | The 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. | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-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. | ||||
Short | Information about the entity attesting to information | ||||
Control | 1..1 | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-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. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
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. | ||||
Short | Additional 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | 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() ) | ||||
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). | ||||
Short | Extensions 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | 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 | ||||
Invariants | 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() ) | ||||
70. VerificationResult.attestation.who | |||||
Definition | The individual or organization attesting to information. | ||||
Short | The individual or organization attesting to information | ||||
Control | 1..1 | ||||
Type | Reference(NDH Base Organization Profile, NDH Base Practitioner Profile, NDH Base PractitionerRole) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
72. VerificationResult.attestation.onBehalfOf | |||||
Definition | When the who is asserting on behalf of another (organization or individual). | ||||
Short | When the who is asserting on behalf of another (organization or individual) | ||||
Control | 0..1 | ||||
Type | Reference(NDH Base Organization Profile, NDH Base Practitioner Profile, NDH Base PractitionerRole) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||
Summary | true | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
74. VerificationResult.attestation.communicationMethod | |||||
Definition | The method by which attested information was submitted/retrieved (manual; API; Push). | ||||
Short | The method by which attested information was submitted/retrieved | ||||
Control | 1..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from VerificationResult Communication Method (extensible to http://terminology.hl7.org/ValueSet/verificationresult-communication-method ) | ||||
Type | CodeableConcept | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-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. | ||||
Short | The date the information was attested to | ||||
Control | 1..1 | ||||
Type | date | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | true | ||||
Invariants | ele-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. | ||||
Short | A digital identity certificate associated with the attestation source | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-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. | ||||
Short | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-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. | ||||
Short | Proxy signature | ||||
Control | 0..1 | ||||
Type | Signature | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-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. | ||||
Short | Attester signature | ||||
Control | 0..1 | ||||
Type | Signature | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-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. | ||||
Short | Information about the entity validating information | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-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. | ||||
Short | Unique id for inter-element referencing | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
Summary | false | ||||
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. | ||||
Short | Additional 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | false | ||||
Summary | false | ||||
Alternate Names | extensions, user content | ||||
Invariants | 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() ) | ||||
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). | ||||
Short | Extensions 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. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
Summary | 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 | ||||
Invariants | 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() ) | ||||
94. VerificationResult.validator.organization | |||||
Definition | Reference to the organization validating information. | ||||
Short | Reference to the organization validating information | ||||
Control | 1..1 | ||||
Type | Reference(NDH Base Organization Profile) | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||
96. VerificationResult.validator.identityCertificate | |||||
Definition | A digital identity certificate associated with the validator. | ||||
Short | A digital identity certificate associated with the validator | ||||
Control | 0..1 | ||||
Type | string | ||||
Is Modifier | false | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-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. | ||||
Short | Validator signature | ||||
Control | 0..1 | ||||
Type | Signature | ||||
Is Modifier | false | ||||
Must Support | true | ||||
Summary | false | ||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |