This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) in it's permanent home (it will always be available at this URL). 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 Narrative
@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 "Narrative"]; fhir:Resource.meta [ fhir:Meta.lastUpdated [ fhir:value "2019-11-01T09:29:23.356+11:00" ] ]; 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/Narrative"]; fhir:StructureDefinition.version [ fhir:value "4.0.1"]; fhir:StructureDefinition.name [ fhir:value "Narrative"]; fhir:StructureDefinition.status [ fhir:value "active"]; fhir:StructureDefinition.date [ fhir:value "2019-11-01T09:29:23+11: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 Narrative Type: A human-readable summary of the resource conveying the essential clinical and business information for the resource."]; fhir:StructureDefinition.fhirVersion [ fhir:value "4.0.1"]; fhir:StructureDefinition.mapping [ fhir:index 0; 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 "Narrative"]; 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 "Narrative" ]; 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 "Narrative" ]; fhir:ElementDefinition.short [ fhir:value "Human-readable summary of the resource (essential clinical and business information)" ]; fhir:ElementDefinition.definition [ fhir:value "A human-readable summary of the resource conveying the essential clinical and business information for the resource." ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "*" ]; fhir:ElementDefinition.base [ fhir:ElementDefinition.path [ fhir:value "Narrative" ]; 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" ]; 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.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 "rim" ]; fhir:ElementDefinition.map [ fhir:value "N/A" ] ] ], [ fhir:index 1; fhir:Element.id [ fhir:value "Narrative.id" ]; fhir:ElementDefinition.path [ fhir:value "Narrative.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 "string" ] ]; 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 "Narrative.extension" ]; fhir:ElementDefinition.path [ fhir:value "Narrative.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 "Narrative.status" ]; fhir:ElementDefinition.path [ fhir:value "Narrative.status" ]; fhir:ElementDefinition.short [ fhir:value "generated | extensions | additional | empty" ]; fhir:ElementDefinition.definition [ fhir:value "The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data." ]; fhir:ElementDefinition.min [ fhir:value "1" ]; fhir:ElementDefinition.max [ fhir:value "1" ]; fhir:ElementDefinition.base [ fhir:ElementDefinition.path [ fhir:value "Narrative.status" ]; fhir:ElementDefinition.min [ fhir:value "1" ]; fhir:ElementDefinition.max [ fhir:value "1" ] ]; fhir:ElementDefinition.type [ fhir:index 0; fhir:ElementDefinition.code [ fhir:value "code" ] ]; 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 "false" ]; fhir:ElementDefinition.binding [ fhir:Element.extension [ fhir:index 0; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ]; fhir:Extension.value [ fhir:value "NarrativeStatus" ] ]; fhir:ElementDefinition.strength [ fhir:value "required" ]; fhir:ElementDefinition.description [ fhir:value "The status of a resource narrative." ]; fhir:ElementDefinition.valueSet [ fhir:value "http://hl7.org/fhir/ValueSet/narrative-status|4.0.1" ] ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value "N/A" ] ] ], [ fhir:index 4; fhir:Element.id [ fhir:value "Narrative.div" ]; fhir:ElementDefinition.path [ fhir:value "Narrative.div" ]; fhir:ElementDefinition.short [ fhir:value "Limited xhtml content" ]; fhir:ElementDefinition.definition [ fhir:value "The actual narrative content, a stripped down version of XHTML." ]; fhir:ElementDefinition.comment [ fhir:value "The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects." ]; fhir:ElementDefinition.min [ fhir:value "1" ]; fhir:ElementDefinition.max [ fhir:value "1" ]; fhir:ElementDefinition.base [ fhir:ElementDefinition.path [ fhir:value "Narrative.div" ]; fhir:ElementDefinition.min [ fhir:value "1" ]; fhir:ElementDefinition.max [ fhir:value "1" ] ]; fhir:ElementDefinition.type [ fhir:index 0; fhir:ElementDefinition.code [ fhir:value "xhtml" ] ]; 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 "txt-1" ]; fhir:ElementDefinition.severity [ fhir:value "error" ]; fhir:ElementDefinition.human [ fhir:value "The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes" ]; fhir:ElementDefinition.expression [ fhir:value "htmlChecks()" ]; fhir:ElementDefinition.xpath [ fhir:value "not(descendant-or-self::*[not(local-name(.)=('a', 'abbr', 'acronym', 'b', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'col', 'colgroup', 'dd', 'dfn', 'div', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 'samp', 'small', 'span', 'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'ul', 'var'))]) and not(descendant-or-self::*/@*[not(name(.)=('abbr', 'accesskey', 'align', 'alt', 'axis', 'bgcolor', 'border', 'cellhalign', 'cellpadding', 'cellspacing', 'cellvalign', 'char', 'charoff', 'charset', 'cite', 'class', 'colspan', 'compact', 'coords', 'dir', 'frame', 'headers', 'height', 'href', 'hreflang', 'hspace', 'id', 'lang', 'longdesc', 'name', 'nowrap', 'rel', 'rev', 'rowspan', 'rules', 'scope', 'shape', 'span', 'src', 'start', 'style', 'summary', 'tabindex', 'title', 'type', 'valign', 'value', 'vspace', 'width'))])" ] ], [ fhir:index 2; fhir:ElementDefinition.key [ fhir:value "txt-2" ]; fhir:ElementDefinition.severity [ fhir:value "error" ]; fhir:ElementDefinition.human [ fhir:value "The narrative SHALL have some non-whitespace content" ]; fhir:ElementDefinition.expression [ fhir:value "htmlChecks()" ]; fhir:ElementDefinition.xpath [ fhir:value "descendant::text()[normalize-space(.)!=''] or descendant::h:img[@src]" ] ]; 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:StructureDefinition.differential [ fhir:StructureDefinition.element [ fhir:index 0; fhir:Element.id [ fhir:value "Narrative" ]; 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 "Narrative" ]; fhir:ElementDefinition.short [ fhir:value "Human-readable summary of the resource (essential clinical and business information)" ]; fhir:ElementDefinition.definition [ fhir:value "A human-readable summary of the resource conveying the essential clinical and business information for the resource." ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "*" ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value "N/A" ] ] ], [ fhir:index 1; fhir:Element.id [ fhir:value "Narrative.status" ]; fhir:ElementDefinition.path [ fhir:value "Narrative.status" ]; fhir:ElementDefinition.short [ fhir:value "generated | extensions | additional | empty" ]; fhir:ElementDefinition.definition [ fhir:value "The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data." ]; fhir:ElementDefinition.min [ fhir:value "1" ]; fhir:ElementDefinition.max [ fhir:value "1" ]; fhir:ElementDefinition.type [ fhir:index 0; fhir:ElementDefinition.code [ fhir:value "code" ] ]; fhir:ElementDefinition.binding [ fhir:Element.extension [ fhir:index 0; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ]; fhir:Extension.value [ fhir:value "NarrativeStatus" ] ]; fhir:ElementDefinition.strength [ fhir:value "required" ]; fhir:ElementDefinition.description [ fhir:value "The status of a resource narrative." ]; fhir:ElementDefinition.valueSet [ fhir:value "http://hl7.org/fhir/ValueSet/narrative-status|4.0.1" ] ]; 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 "Narrative.div" ]; fhir:ElementDefinition.path [ fhir:value "Narrative.div" ]; fhir:ElementDefinition.short [ fhir:value "Limited xhtml content" ]; fhir:ElementDefinition.definition [ fhir:value "The actual narrative content, a stripped down version of XHTML." ]; fhir:ElementDefinition.comment [ fhir:value "The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects." ]; fhir:ElementDefinition.min [ fhir:value "1" ]; fhir:ElementDefinition.max [ fhir:value "1" ]; fhir:ElementDefinition.type [ fhir:index 0; fhir:ElementDefinition.code [ fhir:value "xhtml" ] ]; fhir:ElementDefinition.constraint [ fhir:index 0; fhir:ElementDefinition.key [ fhir:value "txt-1" ]; fhir:ElementDefinition.severity [ fhir:value "error" ]; fhir:ElementDefinition.human [ fhir:value "The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes" ]; fhir:ElementDefinition.expression [ fhir:value "htmlChecks()" ]; fhir:ElementDefinition.xpath [ fhir:value "not(descendant-or-self::*[not(local-name(.)=('a', 'abbr', 'acronym', 'b', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'col', 'colgroup', 'dd', 'dfn', 'div', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 'samp', 'small', 'span', 'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'ul', 'var'))]) and not(descendant-or-self::*/@*[not(name(.)=('abbr', 'accesskey', 'align', 'alt', 'axis', 'bgcolor', 'border', 'cellhalign', 'cellpadding', 'cellspacing', 'cellvalign', 'char', 'charoff', 'charset', 'cite', 'class', 'colspan', 'compact', 'coords', 'dir', 'frame', 'headers', 'height', 'href', 'hreflang', 'hspace', 'id', 'lang', 'longdesc', 'name', 'nowrap', 'rel', 'rev', 'rowspan', 'rules', 'scope', 'shape', 'span', 'src', 'start', 'style', 'summary', 'tabindex', 'title', 'type', 'valign', 'value', 'vspace', 'width'))])" ] ], [ fhir:index 1; fhir:ElementDefinition.key [ fhir:value "txt-2" ]; fhir:ElementDefinition.severity [ fhir:value "error" ]; fhir:ElementDefinition.human [ fhir:value "The narrative SHALL have some non-whitespace content" ]; fhir:ElementDefinition.expression [ fhir:value "htmlChecks()" ]; fhir:ElementDefinition.xpath [ fhir:value "descendant::text()[normalize-space(.)!=''] or descendant::h:img[@src]" ] ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value "N/A" ] ] ] ] . # -------------------------------------------------------------------------------------
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.