Da Vinci Risk Adjustment Implementation Guide
2.0.0-ballot - STU2 Ballot United States of America flag

This page is part of the Da Vinci Risk Adjustment FHIR Implementation Guide (v2.0.0-ballot: STU2 (v2.0.0) Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

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:

Formal Views of Extension Content

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

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionAnnotation
... extension:annotator 0..1ExtensionWho added the annotation
.... url 1..1uri"annotator"
.... value[x] 1..1Reference(US Core Organization Profile | US Core Practitioner Profile | US Core PractitionerRole Profile)Value of extension
... extension:annotated 0..1ExtensionWhen annotation was added
.... url 1..1uri"annotated"
.... value[x] 1..1dateTimeValue of extension
... extension:text 0..1ExtensionFree text annotation
.... url 1..1uri"text"
.... value[x] 1..1stringValue of extension
.... url 1..1uri"code"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Coding Gap Annotation (extensible)
... extension:relatedData 0..1ExtensionRelated data
.... url 1..1uri"relatedData"
.... value[x] 1..1IdentifierValue of extension
... url 1..1uri"http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-annotation"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionAnnotation
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:annotator 0..1ExtensionWho added the annotation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"annotator"
.... value[x] 1..1Reference(US Core Organization Profile | US Core Practitioner Profile | US Core PractitionerRole Profile)Value of extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"annotated"
.... value[x] 1..1dateTimeValue of extension
... extension:text 0..1ExtensionFree text annotation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"text"
.... value[x] 1..1stringValue of extension
... extension:code 0..1ExtensionCoded anotation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"code"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Coding Gap Annotation (extensible)
... extension:relatedData 0..1ExtensionRelated data
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"relatedData"
.... value[x] 1..1IdentifierValue of extension
... url 1..1uri"http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-annotation"

doco 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionAnnotation
... extension:annotator 0..1ExtensionWho added the annotation
.... url 1..1uri"annotator"
.... value[x] 1..1Reference(US Core Organization Profile | US Core Practitioner Profile | US Core PractitionerRole Profile)Value of extension
... extension:annotated 0..1ExtensionWhen annotation was added
.... url 1..1uri"annotated"
.... value[x] 1..1dateTimeValue of extension
... extension:text 0..1ExtensionFree text annotation
.... url 1..1uri"text"
.... value[x] 1..1stringValue of extension
.... url 1..1uri"code"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Coding Gap Annotation (extensible)
... extension:relatedData 0..1ExtensionRelated data
.... url 1..1uri"relatedData"
.... value[x] 1..1IdentifierValue of extension
... url 1..1uri"http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-annotation"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionAnnotation
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:annotator 0..1ExtensionWho added the annotation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"annotator"
.... value[x] 1..1Reference(US Core Organization Profile | US Core Practitioner Profile | US Core PractitionerRole Profile)Value of extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"annotated"
.... value[x] 1..1dateTimeValue of extension
... extension:text 0..1ExtensionFree text annotation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"text"
.... value[x] 1..1stringValue of extension
... extension:code 0..1ExtensionCoded anotation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"code"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Coding Gap Annotation (extensible)
... extension:relatedData 0..1ExtensionRelated data
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"relatedData"
.... value[x] 1..1IdentifierValue of extension
... url 1..1uri"http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-annotation"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:code.value[x]extensibleCodingGapAnnotation (a valid code from Coding Gap Annotation CodeSystem)

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()