This page is part of the FHIR Specification (v4.3.0: R4B - STU). The current version which supercedes this version is 5.0.0. 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:Resource.id [ fhir:value "Annotation"]; fhir:DomainResource.text [ fhir:Narrative.status [ fhir:value "generated" ] ]; fhir:DomainResource.extension [ fhir:index 0; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ]; fhir:Extension.value [ fhir:value "normative" ] ], [ fhir:index 1; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version" ]; fhir:Extension.value [ fhir:value "4.0.0" ] ]; fhir:StructureDefinition.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/Annotation"]; fhir:StructureDefinition.version [ fhir:value "4.3.0"]; fhir:StructureDefinition.name [ fhir:value "Annotation"]; fhir:StructureDefinition.status [ fhir:value "active"]; fhir:StructureDefinition.experimental [ fhir:value "false"]; fhir:StructureDefinition.date [ fhir:value "2022-05-28T12:47:40+10:00"]; fhir:StructureDefinition.publisher [ fhir:value "HL7 FHIR Standard"]; fhir:StructureDefinition.contact [ fhir:index 0; fhir:ContactDetail.telecom [ fhir:index 0; fhir:ContactPoint.system [ fhir:value "url" ]; fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ] ] ]; fhir:StructureDefinition.description [ fhir:value "Base StructureDefinition for Annotation Type: A text note which also contains information about who made the statement and when."]; fhir:StructureDefinition.fhirVersion [ fhir:value "4.3.0"]; fhir:StructureDefinition.mapping [ fhir:index 0; fhir:StructureDefinition.identity [ fhir:value "v2" ]; fhir:StructureDefinition.uri [ fhir:value "http://hl7.org/v2" ]; fhir:StructureDefinition.name [ fhir:value "HL7 v2 Mapping" ] ], [ fhir:index 1; fhir:StructureDefinition.identity [ fhir:value "rim" ]; fhir:StructureDefinition.uri [ fhir:value "http://hl7.org/v3" ]; fhir:StructureDefinition.name [ fhir:value "RIM Mapping" ] ]; fhir:StructureDefinition.kind [ fhir:value "complex-type"]; fhir:StructureDefinition.abstract [ fhir:value "false"]; fhir:StructureDefinition.type [ fhir:value "Annotation"]; fhir:StructureDefinition.baseDefinition [ fhir:value "http://hl7.org/fhir/StructureDefinition/Element"]; fhir:StructureDefinition.derivation [ fhir:value "specialization"]; fhir:StructureDefinition.snapshot [ fhir:StructureDefinition.element [ fhir:index 0; fhir:Element.id [ fhir:value "Annotation" ]; fhir:Element.extension [ fhir:index 0; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ]; fhir:Extension.value [ fhir:value "normative" ] ], [ fhir:index 1; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version" ]; fhir:Extension.value [ fhir:value "4.0.0" ] ]; fhir:ElementDefinition.path [ fhir:value "Annotation" ]; fhir:ElementDefinition.short [ fhir:value "Text node with attribution" ]; fhir:ElementDefinition.definition [ fhir:value "A text note which also contains information about who made the statement and when." ]; fhir:ElementDefinition.comment [ fhir:value "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:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "*" ]; fhir:ElementDefinition.base [ fhir:ElementDefinition.path [ fhir:value "Annotation" ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "*" ] ]; fhir:ElementDefinition.condition [ fhir:value "ele-1"; fhir:index 0 ]; fhir:ElementDefinition.constraint [ fhir:index 0; fhir:ElementDefinition.key [ fhir:value "ele-1" ]; fhir:ElementDefinition.severity [ fhir:value "error" ]; fhir:ElementDefinition.human [ fhir:value "All FHIR elements must have a @value or children unless an empty Parameters resource" ]; fhir:ElementDefinition.expression [ fhir:value "hasValue() or (children().count() > id.count()) or $this is Parameters" ]; fhir:ElementDefinition.xpath [ fhir:value "@value|f:*|h:div|self::f:Parameters" ]; fhir:ElementDefinition.source [ fhir:value "http://hl7.org/fhir/StructureDefinition/Element" ] ]; fhir:ElementDefinition.isModifier [ fhir:value "false" ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value "n/a" ] ], [ fhir:index 1; fhir:ElementDefinition.identity [ fhir:value "v2" ]; fhir:ElementDefinition.map [ fhir:value "N/A" ] ], [ fhir:index 2; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value "Act" ] ] ], [ fhir:index 1; fhir:Element.id [ fhir:value "Annotation.id" ]; fhir:ElementDefinition.path [ fhir:value "Annotation.id" ]; fhir:ElementDefinition.representation [ fhir:value "xmlAttr"; fhir:index 0 ]; fhir:ElementDefinition.short [ fhir:value "Unique id for inter-element referencing" ]; fhir:ElementDefinition.definition [ fhir:value "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "1" ]; fhir:ElementDefinition.base [ fhir:ElementDefinition.path [ fhir:value "Element.id" ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "1" ] ]; fhir:ElementDefinition.type [ fhir:index 0; fhir:Element.extension [ fhir:index 0; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type" ]; fhir:Extension.value [ fhir:value "id" ] ]; fhir:ElementDefinition.code [ fhir:value "http://hl7.org/fhirpath/System.String" ] ]; fhir:ElementDefinition.isModifier [ fhir:value "false" ]; fhir:ElementDefinition.isSummary [ fhir:value "false" ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value "n/a" ] ] ], [ fhir:index 2; fhir:Element.id [ fhir:value "Annotation.extension" ]; fhir:ElementDefinition.path [ fhir:value "Annotation.extension" ]; fhir:ElementDefinition.slicing [ fhir:ElementDefinition.discriminator [ fhir:index 0; fhir:ElementDefinition.type [ fhir:value "value" ]; fhir:ElementDefinition.path [ fhir:value "url" ] ]; fhir:ElementDefinition.description [ fhir:value "Extensions are always sliced by (at least) url" ]; fhir:ElementDefinition.rules [ fhir:value "open" ] ]; fhir:ElementDefinition.short [ fhir:value "Additional content defined by implementations" ]; fhir:ElementDefinition.definition [ fhir:value "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." ]; fhir:ElementDefinition.comment [ fhir:value "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:ElementDefinition.alias [ fhir:value "extensions"; fhir:index 0 ], [ fhir:value "user content"; fhir:index 1 ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "*" ]; fhir:ElementDefinition.base [ fhir:ElementDefinition.path [ fhir:value "Element.extension" ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "*" ] ]; fhir:ElementDefinition.type [ fhir:index 0; fhir:ElementDefinition.code [ fhir:value "Extension" ] ]; fhir:ElementDefinition.constraint [ fhir:index 0; fhir:ElementDefinition.key [ fhir:value "ele-1" ]; fhir:ElementDefinition.severity [ fhir:value "error" ]; fhir:ElementDefinition.human [ fhir:value "All FHIR elements must have a @value or children" ]; fhir:ElementDefinition.expression [ fhir:value "hasValue() or (children().count() > id.count())" ]; fhir:ElementDefinition.xpath [ fhir:value "@value|f:*|h:div" ]; fhir:ElementDefinition.source [ fhir:value "http://hl7.org/fhir/StructureDefinition/Element" ] ], [ fhir:index 1; fhir:ElementDefinition.key [ fhir:value "ext-1" ]; fhir:ElementDefinition.severity [ fhir:value "error" ]; fhir:ElementDefinition.human [ fhir:value "Must have either extensions or value[x], not both" ]; fhir:ElementDefinition.expression [ fhir:value "extension.exists() != value.exists()" ]; fhir:ElementDefinition.xpath [ fhir:value "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" ]; fhir:ElementDefinition.source [ fhir:value "http://hl7.org/fhir/StructureDefinition/Extension" ] ]; fhir:ElementDefinition.isModifier [ fhir:value "false" ]; fhir:ElementDefinition.isSummary [ fhir:value "false" ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value "n/a" ] ] ], [ fhir:index 3; fhir:Element.id [ fhir:value "Annotation.author[x]" ]; fhir:ElementDefinition.path [ fhir:value "Annotation.author[x]" ]; fhir:ElementDefinition.short [ fhir:value "Individual responsible for the annotation" ]; fhir:ElementDefinition.definition [ fhir:value "The individual responsible for making the annotation." ]; fhir:ElementDefinition.comment [ fhir:value "Organization is used when there's no need for specific attribution as to who made the comment." ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "1" ]; fhir:ElementDefinition.base [ fhir:ElementDefinition.path [ fhir:value "Annotation.author[x]" ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "1" ] ]; fhir:ElementDefinition.type [ fhir:index 0; fhir:ElementDefinition.code [ fhir:value "Reference" ]; fhir:ElementDefinition.targetProfile [ fhir:value "http://hl7.org/fhir/StructureDefinition/Practitioner"; fhir:index 0 ], [ fhir:value "http://hl7.org/fhir/StructureDefinition/Patient"; fhir:index 1 ], [ fhir:value "http://hl7.org/fhir/StructureDefinition/RelatedPerson"; fhir:index 2 ], [ fhir:value "http://hl7.org/fhir/StructureDefinition/Organization"; fhir:index 3 ] ], [ fhir:index 1; fhir:ElementDefinition.code [ fhir:value "string" ] ]; fhir:ElementDefinition.constraint [ fhir:index 0; fhir:ElementDefinition.key [ fhir:value "ele-1" ]; fhir:ElementDefinition.severity [ fhir:value "error" ]; fhir:ElementDefinition.human [ fhir:value "All FHIR elements must have a @value or children" ]; fhir:ElementDefinition.expression [ fhir:value "hasValue() or (children().count() > id.count())" ]; fhir:ElementDefinition.xpath [ fhir:value "@value|f:*|h:div" ]; fhir:ElementDefinition.source [ fhir:value "http://hl7.org/fhir/StructureDefinition/Element" ] ]; fhir:ElementDefinition.isModifier [ fhir:value "false" ]; fhir:ElementDefinition.isSummary [ fhir:value "true" ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "v2" ]; fhir:ElementDefinition.map [ fhir:value "N/A" ] ], [ fhir:index 1; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value "Act.participant[typeCode=AUT].role" ] ] ], [ fhir:index 4; fhir:Element.id [ fhir:value "Annotation.time" ]; fhir:ElementDefinition.path [ fhir:value "Annotation.time" ]; fhir:ElementDefinition.short [ fhir:value "When the annotation was made" ]; fhir:ElementDefinition.definition [ fhir:value "Indicates when this particular annotation was made." ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "1" ]; fhir:ElementDefinition.base [ fhir:ElementDefinition.path [ fhir:value "Annotation.time" ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "1" ] ]; fhir:ElementDefinition.type [ fhir:index 0; fhir:ElementDefinition.code [ fhir:value "dateTime" ] ]; fhir:ElementDefinition.constraint [ fhir:index 0; fhir:ElementDefinition.key [ fhir:value "ele-1" ]; fhir:ElementDefinition.severity [ fhir:value "error" ]; fhir:ElementDefinition.human [ fhir:value "All FHIR elements must have a @value or children" ]; fhir:ElementDefinition.expression [ fhir:value "hasValue() or (children().count() > id.count())" ]; fhir:ElementDefinition.xpath [ fhir:value "@value|f:*|h:div" ]; fhir:ElementDefinition.source [ fhir:value "http://hl7.org/fhir/StructureDefinition/Element" ] ]; fhir:ElementDefinition.isModifier [ fhir:value "false" ]; fhir:ElementDefinition.isSummary [ fhir:value "true" ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "v2" ]; fhir:ElementDefinition.map [ fhir:value "N/A" ] ], [ fhir:index 1; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value "Act.effectiveTime" ] ] ], [ fhir:index 5; fhir:Element.id [ fhir:value "Annotation.text" ]; fhir:ElementDefinition.path [ fhir:value "Annotation.text" ]; fhir:ElementDefinition.short [ fhir:value "The annotation - text content (as markdown)" ]; fhir:ElementDefinition.definition [ fhir:value "The text of the annotation in markdown format." ]; fhir:ElementDefinition.min [ fhir:value "1" ]; fhir:ElementDefinition.max [ fhir:value "1" ]; fhir:ElementDefinition.base [ fhir:ElementDefinition.path [ fhir:value "Annotation.text" ]; fhir:ElementDefinition.min [ fhir:value "1" ]; fhir:ElementDefinition.max [ fhir:value "1" ] ]; fhir:ElementDefinition.type [ fhir:index 0; fhir:ElementDefinition.code [ fhir:value "markdown" ] ]; fhir:ElementDefinition.constraint [ fhir:index 0; fhir:ElementDefinition.key [ fhir:value "ele-1" ]; fhir:ElementDefinition.severity [ fhir:value "error" ]; fhir:ElementDefinition.human [ fhir:value "All FHIR elements must have a @value or children" ]; fhir:ElementDefinition.expression [ fhir:value "hasValue() or (children().count() > id.count())" ]; fhir:ElementDefinition.xpath [ fhir:value "@value|f:*|h:div" ]; fhir:ElementDefinition.source [ fhir:value "http://hl7.org/fhir/StructureDefinition/Element" ] ]; fhir:ElementDefinition.isModifier [ fhir:value "false" ]; fhir:ElementDefinition.isSummary [ fhir:value "true" ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "v2" ]; fhir:ElementDefinition.map [ fhir:value "N/A" ] ], [ fhir:index 1; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value "Act.text" ] ] ] ]; fhir:StructureDefinition.differential [ fhir:StructureDefinition.element [ fhir:index 0; fhir:Element.id [ fhir:value "Annotation" ]; fhir:Element.extension [ fhir:index 0; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ]; fhir:Extension.value [ fhir:value "normative" ] ], [ fhir:index 1; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version" ]; fhir:Extension.value [ fhir:value "4.0.0" ] ]; fhir:ElementDefinition.path [ fhir:value "Annotation" ]; fhir:ElementDefinition.short [ fhir:value "Text node with attribution" ]; fhir:ElementDefinition.definition [ fhir:value "A text note which also contains information about who made the statement and when." ]; fhir:ElementDefinition.comment [ fhir:value "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:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "*" ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "v2" ]; fhir:ElementDefinition.map [ fhir:value "N/A" ] ], [ fhir:index 1; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value "Act" ] ] ], [ fhir:index 1; fhir:Element.id [ fhir:value "Annotation.author[x]" ]; fhir:ElementDefinition.path [ fhir:value "Annotation.author[x]" ]; fhir:ElementDefinition.short [ fhir:value "Individual responsible for the annotation" ]; fhir:ElementDefinition.definition [ fhir:value "The individual responsible for making the annotation." ]; fhir:ElementDefinition.comment [ fhir:value "Organization is used when there's no need for specific attribution as to who made the comment." ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "1" ]; fhir:ElementDefinition.type [ fhir:index 0; fhir:ElementDefinition.code [ fhir:value "Reference" ]; fhir:ElementDefinition.targetProfile [ fhir:value "http://hl7.org/fhir/StructureDefinition/Practitioner"; fhir:index 0 ], [ fhir:value "http://hl7.org/fhir/StructureDefinition/Patient"; fhir:index 1 ], [ fhir:value "http://hl7.org/fhir/StructureDefinition/RelatedPerson"; fhir:index 2 ], [ fhir:value "http://hl7.org/fhir/StructureDefinition/Organization"; fhir:index 3 ] ], [ fhir:index 1; fhir:ElementDefinition.code [ fhir:value "string" ] ]; fhir:ElementDefinition.isSummary [ fhir:value "true" ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "v2" ]; fhir:ElementDefinition.map [ fhir:value "N/A" ] ], [ fhir:index 1; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value "Act.participant[typeCode=AUT].role" ] ] ], [ fhir:index 2; fhir:Element.id [ fhir:value "Annotation.time" ]; fhir:ElementDefinition.path [ fhir:value "Annotation.time" ]; fhir:ElementDefinition.short [ fhir:value "When the annotation was made" ]; fhir:ElementDefinition.definition [ fhir:value "Indicates when this particular annotation was made." ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "1" ]; fhir:ElementDefinition.type [ fhir:index 0; fhir:ElementDefinition.code [ fhir:value "dateTime" ] ]; fhir:ElementDefinition.isSummary [ fhir:value "true" ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "v2" ]; fhir:ElementDefinition.map [ fhir:value "N/A" ] ], [ fhir:index 1; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value "Act.effectiveTime" ] ] ], [ fhir:index 3; fhir:Element.id [ fhir:value "Annotation.text" ]; fhir:ElementDefinition.path [ fhir:value "Annotation.text" ]; fhir:ElementDefinition.short [ fhir:value "The annotation - text content (as markdown)" ]; fhir:ElementDefinition.definition [ fhir:value "The text of the annotation in markdown format." ]; fhir:ElementDefinition.min [ fhir:value "1" ]; fhir:ElementDefinition.max [ fhir:value "1" ]; fhir:ElementDefinition.type [ fhir:index 0; fhir:ElementDefinition.code [ fhir:value "markdown" ] ]; fhir:ElementDefinition.isSummary [ fhir:value "true" ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "v2" ]; fhir:ElementDefinition.map [ fhir:value "N/A" ] ], [ fhir:index 1; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value "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.