{
"description": "Annotation DataType with added CodeableConcept extension element",
"_filename": "StructureDefinition-coded-annotation.json",
"package_name": "hl7.fhir.uv.genomics-reporting",
"date": "2024-12-12T20:43:36+00:00",
"derivation": "constraint",
"publisher": "HL7 International / Clinical Genomics",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"name": "CodedAnnotation",
"mapping": [ {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "Annotation",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "Coded Annotation",
"package_version": "3.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "cg"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Annotation",
"min": 0,
"definition": "A text note which also contains information about who made the statement and when.",
"isModifier": false,
"short": "Text node with attribution",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "v2"
}, {
"map": "Act",
"identity": "rim"
} ],
"max": "*",
"id": "Annotation",
"condition": [ "ele-1" ],
"comment": "For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. *Annotations SHOULD NOT* be used to communicate \"modifying\" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).",
"base": {
"max": "*",
"min": 0,
"path": "Annotation"
}
}, {
"path": "Annotation.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Annotation.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Annotation.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Annotation.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Annotation.extension",
"min": 0,
"definition": "Codifies the content of an Annotation",
"isModifier": false,
"short": "Annotation Code",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/annotation-code" ]
} ],
"sliceName": "code",
"max": "1",
"id": "Annotation.extension:code",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Annotation.author[x]",
"min": 0,
"definition": "The individual responsible for making the annotation.",
"isModifier": false,
"short": "Individual responsible for the annotation",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "Act.participant[typeCode=AUT].role",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Organization" ]
}, {
"code": "string"
} ],
"max": "1",
"id": "Annotation.author[x]",
"comment": "Organization is used when there's no need for specific attribution as to who made the comment.",
"base": {
"max": "1",
"min": 0,
"path": "Annotation.author[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Annotation.time",
"min": 0,
"definition": "Indicates when this particular annotation was made.",
"isModifier": false,
"short": "When the annotation was made",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "Act.effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Annotation.time",
"base": {
"max": "1",
"min": 0,
"path": "Annotation.time"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Annotation.text",
"min": 1,
"definition": "The text of the annotation in markdown format.",
"isModifier": false,
"short": "The annotation - text content (as markdown)",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "Act.text",
"identity": "rim"
} ],
"type": [ {
"code": "markdown"
} ],
"max": "1",
"id": "Annotation.text",
"base": {
"max": "1",
"min": 1,
"path": "Annotation.text"
},
"isSummary": true
} ]
},
"status": "active",
"id": "2373e590-eab8-412d-bc79-f5f9fb7ff9b5",
"kind": "complex-type",
"url": "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/coded-annotation",
"version": "3.0.0",
"differential": {
"element": [ {
"id": "Annotation",
"path": "Annotation"
}, {
"id": "Annotation.extension:code",
"max": "1",
"min": 0,
"path": "Annotation.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/uv/genomics-reporting/StructureDefinition/annotation-code" ]
} ],
"sliceName": "code"
} ]
},
"contact": [ {
"name": "HL7 International / Clinical Genomics",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/clingenomics",
"system": "url"
}, {
"value": "cg@lists.HL7.org",
"system": "email"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Annotation"
}