{
"description": "To promote interoperability of clinical note narrative content in a variety of text formats agnostic to any end consumer use cases.",
"_filename": "StructureDefinition-deep-6-ai-narrative-clinical-note.json",
"package_name": "fhir.deep6.ai",
"date": "2023-08-09",
"derivation": "constraint",
"publisher": "Deep 6 AI",
"fhirVersion": "4.0.1",
"name": "Deep6AINarrativeProfileClinicalNote",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "Narrative",
"experimental": "true",
"resourceType": "StructureDefinition",
"title": "Deep 6 AI Narrative Profile for Clinical Notes",
"package_version": "0.1.2",
"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": "Narrative",
"min": 0,
"definition": "A human-readable summary of the resource conveying the essential clinical and business information for the resource.",
"isModifier": false,
"short": "Human-readable summary of the resource (essential clinical and business information)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"max": "*",
"id": "Narrative",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Narrative"
}
}, {
"path": "Narrative.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": "Narrative.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": "Narrative.extension",
"min": 1,
"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": "Narrative.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": "Narrative.extension",
"min": 1,
"definition": "The free text content of a Clinical Note Narrative",
"isModifier": false,
"short": "Clinical Note Narrative Text Extension",
"type": [ {
"code": "Extension",
"profile": [ "http://deep6.ai/fhir/StructureDefinition/deep-6-ai-clinical-note-text" ]
} ],
"mustSupport": true,
"sliceName": "text",
"max": "1",
"id": "Narrative.extension:text",
"comment": "Only for use with Clinical Notes and sections of Clinical Notes",
"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": "Narrative.status",
"min": 1,
"definition": "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.",
"isModifier": false,
"short": "generated | extensions | additional | empty",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/narrative-status|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NarrativeStatus"
} ],
"description": "The status of a resource narrative."
},
"max": "1",
"id": "Narrative.status",
"base": {
"max": "1",
"min": 1,
"path": "Narrative.status"
},
"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": "txt-1",
"human": "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, elements (either name or href), images and internally contained style attributes",
"xpath": "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'))])",
"source": "http://hl7.org/fhir/StructureDefinition/Narrative",
"severity": "error",
"expression": "htmlChecks()"
}, {
"key": "txt-2",
"human": "The narrative SHALL have some non-whitespace content",
"xpath": "descendant::text()[normalize-space(.)!=''] or descendant::h:img[@src]",
"source": "http://hl7.org/fhir/StructureDefinition/Narrative",
"severity": "error",
"expression": "htmlChecks()"
} ],
"path": "Narrative.div",
"min": 1,
"definition": "The actual narrative content, a stripped down version of XHTML.",
"isModifier": false,
"short": "Limited xhtml content",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "xhtml"
} ],
"max": "1",
"id": "Narrative.div",
"comment": "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, 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.",
"base": {
"max": "1",
"min": 1,
"path": "Narrative.div"
},
"isSummary": false
} ]
},
"status": "active",
"id": "a2c84d40-d535-47dd-a239-a22afcfe15e6",
"kind": "complex-type",
"url": "http://deep6.ai/fhir/StructureDefinition/deep-6-ai-narrative-clinical-note",
"version": "0.1.2",
"differential": {
"element": [ {
"id": "Narrative.extension:text",
"max": "1",
"min": 1,
"path": "Narrative.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://deep6.ai/fhir/StructureDefinition/deep-6-ai-clinical-note-text" ]
} ],
"short": "Clinical Note Narrative Text Extension",
"sliceName": "text",
"mustSupport": true
} ]
},
"contact": [ {
"name": "Deep 6 AI",
"telecom": [ {
"value": "http://deep6.ai/",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Narrative"
}