This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
Modeling and Methodology Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw Turtle (+ also see Turtle/RDF Format Specification)
StructureDefinition for Annotation
@prefix fhir: <http://hl7.org/fhir/> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . # - resource ------------------------------------------------------------------- [] a fhir:StructureDefinition ; fhir:id [ fhir:v "Annotation"] ; fhir:text [ fhir:status [ fhir:v "generated" ] ] ; fhir:extension ( [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ; fhir:value [ fhir:v "normative" ] ] [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version" ] ; fhir:value [ fhir:v "4.0.0" ] ] [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics" ] ; fhir:value [ fhir:v "has-size" ] ] ) ; fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/Annotation"], [ fhir:v "http://hl7.org/fhir/StructureDefinition/Annotation"] ; fhir:version [ fhir:v "5.0.0"], [ fhir:v "5.0.0"] ; fhir:name [ fhir:v "Annotation"], [ fhir:v "Annotation"] ; fhir:status [ fhir:v "active"], [ fhir:v "active"] ; fhir:experimental [ fhir:v "false"], [ fhir:v "false"] ; fhir:date [ fhir:v "2023-03-26T15:21:02+11:00"], [ fhir:v "2023-03-26T15:21:02+11:00"] ; fhir:publisher [ fhir:v "HL7 FHIR Standard"], [ fhir:v "HL7 FHIR Standard"] ; fhir:contact ( [ fhir:telecom ( [ fhir:system [ fhir:v "url" ] ; fhir:value [ fhir:v "http://hl7.org/fhir" ] ] ) ] [ fhir:telecom ( [ fhir:system [ fhir:v "url" ] ; fhir:value [ fhir:v "http://hl7.org/fhir" ] ] ) ] ) ; fhir:description [ fhir:v "Annotation Type: A text note which also contains information about who made the statement and when."], [ fhir:v "Annotation Type: A text note which also contains information about who made the statement and when."] ; fhir:jurisdiction ( [ fhir:coding ( [ fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ; fhir:code [ fhir:v "001" ] ; fhir:display [ fhir:v "World" ] ] ) ] [ fhir:coding ( [ fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ; fhir:code [ fhir:v "001" ] ; fhir:display [ fhir:v "World" ] ] ) ] ) ; fhir:fhirVersion [ fhir:v "5.0.0"] ; fhir:mapping ( [ fhir:identity [ fhir:v "v2" ] ; fhir:uri [ fhir:v "http://hl7.org/v2" ] ; fhir:name [ fhir:v "HL7 V2 Mapping" ] ] [ fhir:identity [ fhir:v "rim" ] ; fhir:uri [ fhir:v "http://hl7.org/v3" ] ; fhir:name [ fhir:v "RIM Mapping" ] ] ) ; fhir:kind [ fhir:v "complex-type"] ; fhir:abstract [ fhir:v "false"] ; fhir:type [ fhir:v "Annotation"] ; fhir:baseDefinition [ fhir:v "http://hl7.org/fhir/StructureDefinition/DataType"] ; fhir:derivation [ fhir:v "specialization"] ; fhir:snapshot [ fhir:element ( [ fhir:id [ fhir:v "Annotation" ] ; fhir:extension ( [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ; fhir:value [ fhir:v "normative" ] ] [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version" ] ; fhir:value [ fhir:v "4.0.0" ] ] ) ; fhir:path [ fhir:v "Annotation" ] ; fhir:short [ fhir:v "Text node with attribution" ] ; fhir:definition [ fhir:v "A text note which also contains information about who made the statement and when." ] ; fhir:comment [ fhir:v "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)." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "*" ] ; fhir:base [ fhir:path [ fhir:v "Annotation" ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "*" ] ] ; fhir:constraint ( [ fhir:key [ fhir:v "ele-1" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ; fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ] ] ) ; fhir:isModifier [ fhir:v "false" ] ; fhir:mapping ( [ fhir:identity [ fhir:v "rim" ] ; fhir:map [ fhir:v "n/a,Act" ] ] [ fhir:identity [ fhir:v "v2" ] ; fhir:map [ fhir:v "N/A" ] ] ) ] [ fhir:id [ fhir:v "Annotation.id" ] ; fhir:path [ fhir:v "Annotation.id" ] ; fhir:representation ( [ fhir:v "xmlAttr" ] ) ; fhir:short [ fhir:v "Unique id for inter-element referencing" ] ; fhir:definition [ fhir:v "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "Element.id" ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ] ; fhir:type ( [ fhir:extension ( [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type" ] ; fhir:value [ fhir:v "id" ] ] ) ; fhir:code [ fhir:v "http://hl7.org/fhirpath/System.String" ] ] ) ; fhir:condition ( [ fhir:v "ele-1" ] ) ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "false" ] ; fhir:mapping ( [ fhir:identity [ fhir:v "rim" ] ; fhir:map [ fhir:v "n/a" ] ] ) ] [ fhir:id [ fhir:v "Annotation.extension" ] ; fhir:path [ fhir:v "Annotation.extension" ] ; fhir:slicing [ fhir:discriminator ( [ fhir:type [ fhir:v "value" ] ; fhir:path [ fhir:v "url" ] ] ) ; fhir:description [ fhir:v "Extensions are always sliced by (at least) url" ] ; fhir:rules [ fhir:v "open" ] ] ; fhir:short [ fhir:v "Additional content defined by implementations" ] ; fhir:definition [ fhir:v "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 managable, 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." ] ; fhir:comment [ fhir:v "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." ] ; fhir:alias ( [ fhir:v "extensions" ] [ fhir:v "user content" ] ) ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "*" ] ; fhir:base [ fhir:path [ fhir:v "Element.extension" ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "*" ] ] ; fhir:type ( [ fhir:code [ fhir:v "Extension" ] ] ) ; fhir:constraint ( [ fhir:key [ fhir:v "ele-1" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ; fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ] ] [ fhir:key [ fhir:v "ext-1" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "Must have either extensions or value[x], not both" ] ; fhir:expression [ fhir:v "extension.exists() != value.exists()" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Extension" ] ] ) ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "false" ] ; fhir:mapping ( [ fhir:identity [ fhir:v "rim" ] ; fhir:map [ fhir:v "n/a" ] ] ) ] [ fhir:id [ fhir:v "Annotation.author[x]" ] ; fhir:path [ fhir:v "Annotation.author[x]" ] ; fhir:short [ fhir:v "Individual responsible for the annotation" ] ; fhir:definition [ fhir:v "The individual responsible for making the annotation." ] ; fhir:comment [ fhir:v "Organization is used when there's no need for specific attribution as to who made the comment." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "Annotation.author[x]" ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ] ; fhir:type ( [ fhir:code [ fhir:v "Reference" ] ; fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Practitioner" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Patient" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Organization" ] ) ] [ fhir:code [ fhir:v "string" ] ] ) ; fhir:constraint ( [ fhir:key [ fhir:v "ele-1" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ; fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ] ] ) ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "true" ] ; fhir:mapping ( [ fhir:identity [ fhir:v "v2" ] ; fhir:map [ fhir:v "N/A" ] ] [ fhir:identity [ fhir:v "rim" ] ; fhir:map [ fhir:v "Act.participant[typeCode=AUT].role" ] ] ) ] [ fhir:id [ fhir:v "Annotation.time" ] ; fhir:path [ fhir:v "Annotation.time" ] ; fhir:short [ fhir:v "When the annotation was made" ] ; fhir:definition [ fhir:v "Indicates when this particular annotation was made." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "Annotation.time" ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ] ; fhir:type ( [ fhir:code [ fhir:v "dateTime" ] ] ) ; fhir:constraint ( [ fhir:key [ fhir:v "ele-1" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ; fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ] ] ) ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "true" ] ; fhir:mapping ( [ fhir:identity [ fhir:v "v2" ] ; fhir:map [ fhir:v "N/A" ] ] [ fhir:identity [ fhir:v "rim" ] ; fhir:map [ fhir:v "Act.effectiveTime" ] ] ) ] [ fhir:id [ fhir:v "Annotation.text" ] ; fhir:path [ fhir:v "Annotation.text" ] ; fhir:short [ fhir:v "The annotation - text content (as markdown)" ] ; fhir:definition [ fhir:v "The text of the annotation in markdown format." ] ; fhir:min [ fhir:v "1" ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "Annotation.text" ] ; fhir:min [ fhir:v "1" ] ; fhir:max [ fhir:v "1" ] ] ; fhir:type ( [ fhir:code [ fhir:v "markdown" ] ] ) ; fhir:constraint ( [ fhir:key [ fhir:v "ele-1" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ; fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ] ] ) ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "true" ] ; fhir:mapping ( [ fhir:identity [ fhir:v "v2" ] ; fhir:map [ fhir:v "N/A" ] ] [ fhir:identity [ fhir:v "rim" ] ; fhir:map [ fhir:v "Act.text" ] ] ) ] ) ] ; fhir:differential [ fhir:element ( [ fhir:id [ fhir:v "Annotation" ] ; fhir:extension ( [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ; fhir:value [ fhir:v "normative" ] ] [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version" ] ; fhir:value [ fhir:v "4.0.0" ] ] ) ; fhir:path [ fhir:v "Annotation" ] ; fhir:short [ fhir:v "Text node with attribution" ] ; fhir:definition [ fhir:v "A text note which also contains information about who made the statement and when." ] ; fhir:comment [ fhir:v "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)." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "*" ] ; fhir:mapping ( [ fhir:identity [ fhir:v "v2" ] ; fhir:map [ fhir:v "N/A" ] ] [ fhir:identity [ fhir:v "rim" ] ; fhir:map [ fhir:v "Act" ] ] ) ] [ fhir:id [ fhir:v "Annotation.author[x]" ] ; fhir:path [ fhir:v "Annotation.author[x]" ] ; fhir:short [ fhir:v "Individual responsible for the annotation" ] ; fhir:definition [ fhir:v "The individual responsible for making the annotation." ] ; fhir:comment [ fhir:v "Organization is used when there's no need for specific attribution as to who made the comment." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ; fhir:type ( [ fhir:code [ fhir:v "Reference" ] ; fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Practitioner" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Patient" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Organization" ] ) ] [ fhir:code [ fhir:v "string" ] ] ) ; fhir:isSummary [ fhir:v "true" ] ; fhir:mapping ( [ fhir:identity [ fhir:v "v2" ] ; fhir:map [ fhir:v "N/A" ] ] [ fhir:identity [ fhir:v "rim" ] ; fhir:map [ fhir:v "Act.participant[typeCode=AUT].role" ] ] ) ] [ fhir:id [ fhir:v "Annotation.time" ] ; fhir:path [ fhir:v "Annotation.time" ] ; fhir:short [ fhir:v "When the annotation was made" ] ; fhir:definition [ fhir:v "Indicates when this particular annotation was made." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ; fhir:type ( [ fhir:code [ fhir:v "dateTime" ] ] ) ; fhir:isSummary [ fhir:v "true" ] ; fhir:mapping ( [ fhir:identity [ fhir:v "v2" ] ; fhir:map [ fhir:v "N/A" ] ] [ fhir:identity [ fhir:v "rim" ] ; fhir:map [ fhir:v "Act.effectiveTime" ] ] ) ] [ fhir:id [ fhir:v "Annotation.text" ] ; fhir:path [ fhir:v "Annotation.text" ] ; fhir:short [ fhir:v "The annotation - text content (as markdown)" ] ; fhir:definition [ fhir:v "The text of the annotation in markdown format." ] ; fhir:min [ fhir:v "1" ] ; fhir:max [ fhir:v "1" ] ; fhir:type ( [ fhir:code [ fhir:v "markdown" ] ] ) ; fhir:isSummary [ fhir:v "true" ] ; fhir:mapping ( [ fhir:identity [ fhir:v "v2" ] ; fhir:map [ fhir:v "N/A" ] ] [ fhir:identity [ fhir:v "rim" ] ; fhir:map [ fhir:v "Act.text" ] ] ) ] ) ] . # -------------------------------------------------------------------------------------
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0 generated on Sun, Mar 26, 2023 15:23+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R4B |
|
Propose a change