Da Vinci Risk Adjustment Implementation Guide
2.0.0-ballot - STU2 Ballot

Publication Build: This will be filled in by the publication tooling

## Extension: Annotation

Official URL: http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-annotation | Version: 2.0.0-ballot
Active as of 2023-03-28 | Computable Name: Annotation
Copyright/Legal: Used by permission of HL7 International - Clinical Quality Information Work Group, all rights reserved Creative Commons License

Annotation

Context of Use

This extension may be used on the following element(s):

- Element ID MeasureReport.group

Usage info

Usage:

- Use this Extension: Risk Adjustment Coding Gap MeasureReport
- Examples for this Extension: MeasureReport/ra-measurereport01-with-annotation

### Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

- Text Summary
- Differential Table
- Snapshot Table
- All

This structure is derived from Extension

Summary

Complex Extension: Annotation

- annotator: Reference: An Extension
- annotated: dateTime: An Extension
- text: string: An Extension
- code: CodeableConcept: An Extension
- relatedData: Identifier: An Extension

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Annotation
extension:annotator |  | 0..1 | Extension | Who added the annotation
url |  | 1..1 | uri | "annotator"
value[x] |  | 1..1 | Reference(US Core Organization Profile | US Core Practitioner Profile | US Core PractitionerRole Profile) | Value of extension
extension:annotated |  | 0..1 | Extension | When annotation was added
url |  | 1..1 | uri | "annotated"
value[x] |  | 1..1 | dateTime | Value of extension
extension:text |  | 0..1 | Extension | Free text annotation
url |  | 1..1 | uri | "text"
value[x] |  | 1..1 | string | Value of extension
extension:code |  | 0..1 | Extension | Coded anotation
url |  | 1..1 | uri | "code"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Coding Gap Annotation (extensible)
extension:relatedData |  | 0..1 | Extension | Related data
url |  | 1..1 | uri | "relatedData"
value[x] |  | 1..1 | Identifier | Value of extension
url |  | 1..1 | uri | "http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-annotation"
value[x] |  | 0..0 |  |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Annotation
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:annotator |  | 0..1 | Extension | Who added the annotation
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "annotator"
value[x] |  | 1..1 | Reference(US Core Organization Profile | US Core Practitioner Profile | US Core PractitionerRole Profile) | Value of extension
extension:annotated |  | 0..1 | Extension | When annotation was added
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "annotated"
value[x] |  | 1..1 | dateTime | Value of extension
extension:text |  | 0..1 | Extension | Free text annotation
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "text"
value[x] |  | 1..1 | string | Value of extension
extension:code |  | 0..1 | Extension | Coded anotation
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "code"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Coding Gap Annotation (extensible)
extension:relatedData |  | 0..1 | Extension | Related data
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "relatedData"
value[x] |  | 1..1 | Identifier | Value of extension
url |  | 1..1 | uri | "http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-annotation"
Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Annotation

- annotator: Reference: An Extension
- annotated: dateTime: An Extension
- text: string: An Extension
- code: CodeableConcept: An Extension
- relatedData: Identifier: An Extension

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Annotation
extension:annotator |  | 0..1 | Extension | Who added the annotation
url |  | 1..1 | uri | "annotator"
value[x] |  | 1..1 | Reference(US Core Organization Profile | US Core Practitioner Profile | US Core PractitionerRole Profile) | Value of extension
extension:annotated |  | 0..1 | Extension | When annotation was added
url |  | 1..1 | uri | "annotated"
value[x] |  | 1..1 | dateTime | Value of extension
extension:text |  | 0..1 | Extension | Free text annotation
url |  | 1..1 | uri | "text"
value[x] |  | 1..1 | string | Value of extension
extension:code |  | 0..1 | Extension | Coded anotation
url |  | 1..1 | uri | "code"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Coding Gap Annotation (extensible)
extension:relatedData |  | 0..1 | Extension | Related data
url |  | 1..1 | uri | "relatedData"
value[x] |  | 1..1 | Identifier | Value of extension
url |  | 1..1 | uri | "http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-annotation"
value[x] |  | 0..0 |  |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Annotation
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:annotator |  | 0..1 | Extension | Who added the annotation
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "annotator"
value[x] |  | 1..1 | Reference(US Core Organization Profile | US Core Practitioner Profile | US Core PractitionerRole Profile) | Value of extension
extension:annotated |  | 0..1 | Extension | When annotation was added
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "annotated"
value[x] |  | 1..1 | dateTime | Value of extension
extension:text |  | 0..1 | Extension | Free text annotation
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "text"
value[x] |  | 1..1 | string | Value of extension
extension:code |  | 0..1 | Extension | Coded anotation
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "code"
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Coding Gap Annotation (extensible)
extension:relatedData |  | 0..1 | Extension | Related data
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "relatedData"
value[x] |  | 1..1 | Identifier | Value of extension
url |  | 1..1 | uri | "http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-annotation"
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

Path | Conformance | ValueSet
Extension.extension:code.value[x] | extensible | CodingGapAnnotation (a valid code from Coding Gap Annotation CodeSystem)

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |