Package org.hl7.fhir.r5.renderers

Class StructureDefinitionRenderer

java.lang.Object

org.hl7.fhir.utilities.TranslatingUtilities

org.hl7.fhir.r5.utils.TranslatingUtilities

org.hl7.fhir.r5.renderers.Renderer

org.hl7.fhir.r5.renderers.DataRenderer

org.hl7.fhir.r5.renderers.ResourceRenderer

org.hl7.fhir.r5.renderers.StructureDefinitionRenderer

All Implemented Interfaces:

CodeResolver

public class StructureDefinitionRenderer
extends ResourceRenderer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	StructureDefinitionRenderer.InternalMarkdownProcessor
protected class	StructureDefinitionRenderer.StatusList<T extends org.hl7.fhir.r5.renderers.StructureDefinitionRenderer.ItemWithStatus>
static class	StructureDefinitionRenderer.UnusedTracker

Nested classes/interfaces inherited from class org.hl7.fhir.r5.renderers.ResourceRenderer

ResourceRenderer.RendererType, ResourceRenderer.TableData, ResourceRenderer.TableRowData

Nested classes/interfaces inherited from class org.hl7.fhir.r5.utils.TranslatingUtilities

TranslatingUtilities.TranslationServices

Nested classes/interfaces inherited from interface org.hl7.fhir.r5.renderers.CodeResolver

CodeResolver.CodeResolution

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONSTRAINT_CHAR
static final String	CONSTRAINT_STYLE
static final int	GEN_MODE_DIFF
static final int	GEN_MODE_KEY
static final int	GEN_MODE_MS
static final int	GEN_MODE_SNAP
static final String	LOINC_MAPPING
static final String	RIM_MAPPING
static final String	SNOMED_MAPPING
static final String	v2_MAPPING

Fields inherited from class org.hl7.fhir.r5.renderers.ResourceRenderer

rcontext, xverManager

Fields inherited from class org.hl7.fhir.r5.renderers.Renderer

context, RENDER_BUNDLE_DOCUMENT_CONTENT, RENDER_BUNDLE_ETAG, RENDER_BUNDLE_HEADER_DOC_ENTRY_RD, RENDER_BUNDLE_HEADER_DOC_ENTRY_U, RENDER_BUNDLE_HEADER_DOC_ENTRY_URD, RENDER_BUNDLE_HEADER_ENTRY, RENDER_BUNDLE_HEADER_ENTRY_URL, RENDER_BUNDLE_HEADER_ROOT, RENDER_BUNDLE_IF_MATCH, RENDER_BUNDLE_IF_MOD, RENDER_BUNDLE_IF_NON_MATCH, RENDER_BUNDLE_IF_NONE, RENDER_BUNDLE_LAST_MOD, RENDER_BUNDLE_LOCATION, RENDER_BUNDLE_REQUEST, RENDER_BUNDLE_RESOURCE, RENDER_BUNDLE_RESPONSE, RENDER_BUNDLE_SEARCH, RENDER_BUNDLE_SEARCH_MODE, RENDER_BUNDLE_SEARCH_SCORE

Constructor Summary

Constructors

Constructor	Description
StructureDefinitionRenderer(RenderingContext context)
StructureDefinitionRenderer(RenderingContext context, Resolver.ResourceContext rcontext)

Method Summary

Modifier and Type	Method	Description
String	codeForAggregation(ElementDefinition.AggregationMode a)
org.hl7.fhir.utilities.xhtml.XhtmlNode	compareMarkdown(String location, PrimitiveType md, PrimitiveType compare, int mode)
org.hl7.fhir.utilities.xhtml.XhtmlNode	compareString(String newStr, Base source, String nLink, String name, Base parent, String oldStr, String oLink, int mode)
boolean	compareString(org.hl7.fhir.utilities.xhtml.XhtmlNode x, String newStr, Base source, String nLink, String name, Base parent, String oldStr, String oLink, int mode)
void	describe(org.hl7.fhir.utilities.xhtml.XhtmlNode x, StructureDefinition sd)
String	display(Resource r)
String	display(StructureDefinition sd)
String	display(BaseWrappers.ResourceWrapper r)
org.hl7.fhir.utilities.xhtml.XhtmlNode	formatTypeSpecifiers(ElementDefinition d)
List<org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Cell>	genElementCells(org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator gen, ElementDefinition element, String profileBaseFileName, boolean snapshot, String corePath, String imagePath, boolean root, boolean logicalModel, boolean allInvariants, StructureDefinition profile, org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Row typesRow, org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Row row, boolean hasDef, boolean ext, StructureDefinitionRenderer.UnusedTracker used, String ref, String sName, org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Cell nameCell, boolean mustSupport, boolean allowSubRows, RenderingContext rc)
org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Cell	genElementNameCell(org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator gen, ElementDefinition element, String profileBaseFileName, boolean snapshot, String corePath, String imagePath, boolean root, boolean logicalModel, boolean allInvariants, StructureDefinition profile, org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Row typesRow, org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Row row, boolean hasDef, boolean ext, StructureDefinitionRenderer.UnusedTracker used, String ref, String sName, List<ElementDefinition> elements)
org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Cell	generateDescription(org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator gen, org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Row row, ElementDefinition definition, ElementDefinition fallback, boolean used, String baseURL, String url, StructureDefinition profile, String corePath, String imagePath, boolean root, boolean logicalModel, boolean allInvariants, boolean snapshot, boolean mustSupportOnly, boolean allowSubRows, RenderingContext rc)
org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Cell	generateDescription(org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator gen, org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Row row, ElementDefinition definition, ElementDefinition fallback, boolean used, String baseURL, String url, StructureDefinition profile, String corePath, String imagePath, boolean root, boolean logicalModel, boolean allInvariants, ElementDefinition valueDefn, boolean snapshot, boolean mustSupportOnly, boolean allowSubRows, RenderingContext rc)
org.hl7.fhir.utilities.xhtml.XhtmlNode	generateExtensionTable(String defFile, StructureDefinition ed, String imageFolder, boolean inlineGraphics, boolean full, String corePath, String imagePath, Set<String> outputTracker, RenderingContext rc)
org.hl7.fhir.utilities.xhtml.XhtmlNode	generateGrid(String defFile, StructureDefinition profile, String imageFolder, boolean inlineGraphics, String profileBaseFileName, String corePath, String imagePath, Set<String> outputTracker)
org.hl7.fhir.utilities.xhtml.XhtmlNode	generateSpanningTable(StructureDefinition profile, String imageFolder, boolean onlyConstraints, String constraintPrefix, Set<String> outputTracker)
org.hl7.fhir.utilities.xhtml.XhtmlNode	generateTable(String defFile, StructureDefinition profile, boolean diff, String imageFolder, boolean inlineGraphics, String profileBaseFileName, boolean snapshot, String corePath, String imagePath, boolean logicalModel, boolean allInvariants, Set<String> outputTracker, boolean mustSupport, RenderingContext rc, String anchorPrefix)
ElementDefinition	getElementById(String url, String id)
IMarkdownProcessor	getHostMd()
Map<String,Map<String,ElementDefinition>>	getSdMapCache()
boolean	hasNonBaseConditions(List<IdType> conditions)
boolean	hasNonBaseConstraints(List<ElementDefinition.ElementDefinitionConstraintComponent> constraints)
String	hintForAggregation(ElementDefinition.AggregationMode a)
org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.TableModel	initCustomTable(org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator gen, String prefix, boolean isLogical, boolean alternating, String id, boolean isActive, List<org.hl7.fhir.r5.renderers.StructureDefinitionRenderer.Column> columns)
boolean	isMustSupport(List<CanonicalType> profiles)
boolean	isMustSupport(CanonicalType profile)
boolean	isMustSupport(ElementDefinition.TypeRefComponent tr)
boolean	isMustSupportDirect(ElementDefinition.TypeRefComponent tr)
protected boolean	isPrimitive(String value)
String	listConstraintsAndConditions(ElementDefinition element)
org.hl7.fhir.utilities.xhtml.XhtmlNode	removed(org.hl7.fhir.utilities.xhtml.XhtmlNode x)
boolean	render(org.hl7.fhir.utilities.xhtml.XhtmlNode x, Resource dr)
boolean	render(org.hl7.fhir.utilities.xhtml.XhtmlNode x, StructureDefinition sd)
void	renderDict(StructureDefinition sd, List<ElementDefinition> elements, org.hl7.fhir.utilities.xhtml.XhtmlNode t, boolean incProfiledOut, int mode, String anchorPrefix)
void	scanBindings(Set<String> cols, List<ElementDefinition> list, ElementDefinition ed)
void	setHostMd(IMarkdownProcessor hostMd)
void	setSdMapCache(Map<String,Map<String,ElementDefinition>> sdMapCache)
List<ElementDefinition>	supplementMissingDiffElements(StructureDefinition profile)
protected String	tail(String path)
org.hl7.fhir.utilities.xhtml.XhtmlNode	unchanged(org.hl7.fhir.utilities.xhtml.XhtmlNode x)

Methods inherited from class org.hl7.fhir.r5.renderers.ResourceRenderer

build, canRender, describe, describe, describeStatus, displayReference, fetchResource, generateCopyright, getProperty, getProperty, getRcontext, getRendererType, inject, makeIdFromBundleEntry, makeInternalBundleLink, parseType, render, render, render, render, render, renderCanonical, renderCanonical, renderCanonical, renderCommitteeLink, renderOrError, renderReference, renderReference, renderReference, renderReference, renderResourceHeader, renderTable, resolveReference, setRcontext, valued

Methods inherited from class org.hl7.fhir.r5.renderers.DataRenderer

addMarkdown, addMarkdown, addTelecom, describeLang, describeSystem, describeVersion, display, display, display, displayBase, displayCodeableConcept, displayCoding, displayCoding, displayContactPoint, displayContactPoint, displayHumanName, displayPeriod, displayQuantity, displayRange, displaySystem, getContext, getLinkForCode, getLocalizedBigDecimalValue, gt, hasRenderableExtensions, hasRenderableExtensions, makeAnchor, makeExceptionXhtml, processRelativeUrls, render, render, renderAddress, renderAnnotation, renderAnnotation, renderBase, renderCodeableConcept, renderCodeableConcept, renderCodeableReference, renderCoding, renderCoding, renderCoding, renderCodingWithDetails, renderContactPoint, renderDataRequirement, renderDate, renderDateTime, renderDateTime, renderExpression, renderExtensionsInList, renderExtensionsInList, renderExtensionsInList, renderExtensionsInText, renderHumanName, renderIdentifier, renderMoney, renderPeriod, renderQuantity, renderQuantity, renderRange, renderSampledData, renderTiming, renderUri, renderUri, renderUsageContext, resolveCode, resolveCode, resolveCode, smartAddText, systemFromCanonical, translate, versionFromCanonical

Methods inherited from class org.hl7.fhir.r5.renderers.Renderer

formatMessage, genStandardsStatus, renderStatus, renderStatusDiv, renderStatusRow, renderStatusSummary

Methods inherited from class org.hl7.fhir.r5.utils.TranslatingUtilities

egt

Methods inherited from class org.hl7.fhir.utilities.TranslatingUtilities

getTranslator, hasTranslator, setTranslator, toStr, toStr, translate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CONSTRAINT_CHAR

public static final String CONSTRAINT_CHAR

See Also:

• Constant Field Values

CONSTRAINT_STYLE

public static final String CONSTRAINT_STYLE

See Also:

• Constant Field Values

GEN_MODE_SNAP

public static final int GEN_MODE_SNAP

See Also:

• Constant Field Values

GEN_MODE_DIFF

public static final int GEN_MODE_DIFF

See Also:

• Constant Field Values

GEN_MODE_MS

public static final int GEN_MODE_MS

See Also:

• Constant Field Values

GEN_MODE_KEY

public static final int GEN_MODE_KEY

See Also:

• Constant Field Values

RIM_MAPPING

public static final String RIM_MAPPING

See Also:

• Constant Field Values

v2_MAPPING

public static final String v2_MAPPING

See Also:

• Constant Field Values

LOINC_MAPPING

public static final String LOINC_MAPPING

See Also:

• Constant Field Values

SNOMED_MAPPING

public static final String SNOMED_MAPPING

See Also:

• Constant Field Values

Constructor Details

StructureDefinitionRenderer

public StructureDefinitionRenderer(RenderingContext context)

StructureDefinitionRenderer

public StructureDefinitionRenderer(RenderingContext context,
 Resolver.ResourceContext rcontext)

Method Details

getSdMapCache

public Map<String,Map<String,ElementDefinition>> getSdMapCache()

setSdMapCache

public void setSdMapCache(Map<String,Map<String,ElementDefinition>> sdMapCache)

getHostMd

public IMarkdownProcessor getHostMd()

setHostMd

public void setHostMd(IMarkdownProcessor hostMd)

render

public boolean render(org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 Resource dr)
               throws org.hl7.fhir.exceptions.FHIRFormatError,
org.hl7.fhir.exceptions.DefinitionException,
IOException

Specified by:

render in class ResourceRenderer

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

org.hl7.fhir.exceptions.DefinitionException

IOException

render

public boolean render(org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 StructureDefinition sd)
               throws org.hl7.fhir.exceptions.FHIRFormatError,
org.hl7.fhir.exceptions.DefinitionException,
IOException

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

org.hl7.fhir.exceptions.DefinitionException

IOException

describe

public void describe(org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 StructureDefinition sd)

display

public String display(StructureDefinition sd)

display

public String display(Resource r)
               throws UnsupportedEncodingException,
IOException

Specified by:

display in class ResourceRenderer

Throws:

UnsupportedEncodingException

IOException

display

public String display(BaseWrappers.ResourceWrapper r)
               throws UnsupportedEncodingException,
IOException

Specified by:

display in class ResourceRenderer

Throws:

UnsupportedEncodingException

IOException

generateGrid

public org.hl7.fhir.utilities.xhtml.XhtmlNode generateGrid(String defFile,
 StructureDefinition profile,
 String imageFolder,
 boolean inlineGraphics,
 String profileBaseFileName,
 String corePath,
 String imagePath,
 Set<String> outputTracker)
                                                    throws IOException,
org.hl7.fhir.exceptions.FHIRException

Throws:

IOException

org.hl7.fhir.exceptions.FHIRException

generateTable

public org.hl7.fhir.utilities.xhtml.XhtmlNode generateTable(String defFile,
 StructureDefinition profile,
 boolean diff,
 String imageFolder,
 boolean inlineGraphics,
 String profileBaseFileName,
 boolean snapshot,
 String corePath,
 String imagePath,
 boolean logicalModel,
 boolean allInvariants,
 Set<String> outputTracker,
 boolean mustSupport,
 RenderingContext rc,
 String anchorPrefix)
                                                     throws IOException,
org.hl7.fhir.exceptions.FHIRException

Throws:

IOException

org.hl7.fhir.exceptions.FHIRException

scanBindings

public void scanBindings(Set<String> cols,
 List<ElementDefinition> list,
 ElementDefinition ed)

initCustomTable

public org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.TableModel initCustomTable(org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator gen,
 String prefix,
 boolean isLogical,
 boolean alternating,
 String id,
 boolean isActive,
 List<org.hl7.fhir.r5.renderers.StructureDefinitionRenderer.Column> columns)
                                                                                   throws IOException

Throws:

IOException

genElementNameCell

public org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Cell genElementNameCell(org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator gen,
 ElementDefinition element,
 String profileBaseFileName,
 boolean snapshot,
 String corePath,
 String imagePath,
 boolean root,
 boolean logicalModel,
 boolean allInvariants,
 StructureDefinition profile,
 org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Row typesRow,
 org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Row row,
 boolean hasDef,
 boolean ext,
 StructureDefinitionRenderer.UnusedTracker used,
 String ref,
 String sName,
 List<ElementDefinition> elements)
                                                                                throws IOException

Throws:

IOException

genElementCells

public List<org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Cell> genElementCells(org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator gen,
 ElementDefinition element,
 String profileBaseFileName,
 boolean snapshot,
 String corePath,
 String imagePath,
 boolean root,
 boolean logicalModel,
 boolean allInvariants,
 StructureDefinition profile,
 org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Row typesRow,
 org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Row row,
 boolean hasDef,
 boolean ext,
 StructureDefinitionRenderer.UnusedTracker used,
 String ref,
 String sName,
 org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Cell nameCell,
 boolean mustSupport,
 boolean allowSubRows,
 RenderingContext rc)
                                                                                   throws IOException

Throws:

IOException

supplementMissingDiffElements

public List<ElementDefinition> supplementMissingDiffElements(StructureDefinition profile)

generateDescription

public org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Cell generateDescription(org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator gen,
 org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Row row,
 ElementDefinition definition,
 ElementDefinition fallback,
 boolean used,
 String baseURL,
 String url,
 StructureDefinition profile,
 String corePath,
 String imagePath,
 boolean root,
 boolean logicalModel,
 boolean allInvariants,
 boolean snapshot,
 boolean mustSupportOnly,
 boolean allowSubRows,
 RenderingContext rc)
                                                                                 throws IOException,
org.hl7.fhir.exceptions.FHIRException

Throws:

IOException

org.hl7.fhir.exceptions.FHIRException

generateDescription

public org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Cell generateDescription(org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator gen,
 org.hl7.fhir.utilities.xhtml.HierarchicalTableGenerator.Row row,
 ElementDefinition definition,
 ElementDefinition fallback,
 boolean used,
 String baseURL,
 String url,
 StructureDefinition profile,
 String corePath,
 String imagePath,
 boolean root,
 boolean logicalModel,
 boolean allInvariants,
 ElementDefinition valueDefn,
 boolean snapshot,
 boolean mustSupportOnly,
 boolean allowSubRows,
 RenderingContext rc)
                                                                                 throws IOException,
org.hl7.fhir.exceptions.FHIRException

Throws:

IOException

org.hl7.fhir.exceptions.FHIRException

codeForAggregation

public String codeForAggregation(ElementDefinition.AggregationMode a)

hintForAggregation

public String hintForAggregation(ElementDefinition.AggregationMode a)

tail

protected String tail(String path)

isPrimitive

protected boolean isPrimitive(String value)

hasNonBaseConditions

public boolean hasNonBaseConditions(List<IdType> conditions)

hasNonBaseConstraints

public boolean hasNonBaseConstraints(List<ElementDefinition.ElementDefinitionConstraintComponent> constraints)

listConstraintsAndConditions

public String listConstraintsAndConditions(ElementDefinition element)

isMustSupportDirect

public boolean isMustSupportDirect(ElementDefinition.TypeRefComponent tr)

isMustSupport

public boolean isMustSupport(ElementDefinition.TypeRefComponent tr)

isMustSupport

public boolean isMustSupport(List<CanonicalType> profiles)

isMustSupport

public boolean isMustSupport(CanonicalType profile)

generateSpanningTable

public org.hl7.fhir.utilities.xhtml.XhtmlNode generateSpanningTable(StructureDefinition profile,
 String imageFolder,
 boolean onlyConstraints,
 String constraintPrefix,
 Set<String> outputTracker)
                                                             throws IOException,
org.hl7.fhir.exceptions.FHIRException

Throws:

IOException

org.hl7.fhir.exceptions.FHIRException

formatTypeSpecifiers

public org.hl7.fhir.utilities.xhtml.XhtmlNode formatTypeSpecifiers(ElementDefinition d)

generateExtensionTable

public org.hl7.fhir.utilities.xhtml.XhtmlNode generateExtensionTable(String defFile,
 StructureDefinition ed,
 String imageFolder,
 boolean inlineGraphics,
 boolean full,
 String corePath,
 String imagePath,
 Set<String> outputTracker,
 RenderingContext rc)
                                                              throws IOException,
org.hl7.fhir.exceptions.FHIRException

Throws:

IOException

org.hl7.fhir.exceptions.FHIRException

renderDict

public void renderDict(StructureDefinition sd,
 List<ElementDefinition> elements,
 org.hl7.fhir.utilities.xhtml.XhtmlNode t,
 boolean incProfiledOut,
 int mode,
 String anchorPrefix)
                throws org.hl7.fhir.exceptions.FHIRException,
IOException

Throws:

org.hl7.fhir.exceptions.FHIRException

IOException

getElementById

public ElementDefinition getElementById(String url,
 String id)

compareMarkdown

public org.hl7.fhir.utilities.xhtml.XhtmlNode compareMarkdown(String location,
 PrimitiveType md,
 PrimitiveType compare,
 int mode)
                                                       throws org.hl7.fhir.exceptions.FHIRException,
IOException

Throws:

org.hl7.fhir.exceptions.FHIRException

IOException

compareString

public org.hl7.fhir.utilities.xhtml.XhtmlNode compareString(String newStr,
 Base source,
 String nLink,
 String name,
 Base parent,
 String oldStr,
 String oLink,
 int mode)

compareString

public boolean compareString(org.hl7.fhir.utilities.xhtml.XhtmlNode x,
 String newStr,
 Base source,
 String nLink,
 String name,
 Base parent,
 String oldStr,
 String oLink,
 int mode)

unchanged

public org.hl7.fhir.utilities.xhtml.XhtmlNode unchanged(org.hl7.fhir.utilities.xhtml.XhtmlNode x)

removed

public org.hl7.fhir.utilities.xhtml.XhtmlNode removed(org.hl7.fhir.utilities.xhtml.XhtmlNode x)