FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/rendering-style

Packagehl7.fhir.uv.extensions
Resource TypeStructureDefinition
Idrendering-style
FHIR VersionR5
Sourcehttp://hl7.org/fhir/extensions/https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-rendering-style.html
URLhttp://hl7.org/fhir/StructureDefinition/rendering-style
Version5.3.0-ballot-tc1
Statusactive
Date2014-04-23
NameRenderingStyle
TitleRendering Style
Realmuv
Authorityhl7
DescriptionIndicates an HTML style that should be applied when rendering this element.
TypeExtension
Kindcomplex-type

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Examples of Use for Extension

ResourceVersion
csiro.fhir.au.smartforms#current:Questionnaire/AboriginalTorresStraitIslanderHealthCheckR4
csiro.fhir.au.smartforms#current:Questionnaire/ExaminationR4
hl7.fhir.us.sirb#current:Questionnaire/sirb-adverse-event-questionnaire-populateR4
hl7.fhir.us.sirb#current:Questionnaire/sirb-consent-questionnaire-populateR4
hl7.fhir.us.sirb#current:Questionnaire/sirb-continuing-review-questionnaire-populateR4
hl7.fhir.us.sirb#current:Questionnaire/sirb-determination-letter-questionnaire-populateR4
hl7.fhir.us.sirb#current:Questionnaire/sirb-initiate-study-questionnaire-populateR4
hl7.fhir.us.sirb#current:Questionnaire/sirb-nonmedicalevent-questionnaire-populateR4
hl7.fhir.us.sirb#current:Questionnaire/sirb-protocol-questionnaire-populateR4
hl7.fhir.us.sirb#current:Questionnaire/sirb-recruitment-materials-questionnaire-populateR4
hl7.fhir.uv.sdc#current:Questionnaire/questionnaire-sdc-profile-example-loincR4
hl7.fhir.uv.sdc#current:Questionnaire/questionnaire-sdc-profile-example-renderR4

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition rendering-style

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1ExtensionHtml style value
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/rendering-style"
... value[x] 1..1stringValue of extension

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "rendering-style",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 3
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode": "can-bind"
    }
  ],
  "url": "http://hl7.org/fhir/StructureDefinition/rendering-style",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:2.16.840.1.113883.4.642.5.1686"
    }
  ],
  "version": "5.3.0-ballot-tc1",
  "name": "RenderingStyle",
  "title": "Rendering Style",
  "status": "active",
  "experimental": false,
  "date": "2014-04-23",
  "publisher": "HL7 International / FHIR Infrastructure",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "description": "Indicates an HTML style that should be applied when rendering this element.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "complex-type",
  "abstract": false,
  "context": [
    {
      "type": "element",
      "expression": "Element"
    }
  ],
  "type": "Extension",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
  "derivation": "constraint",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "5.0.0"
      }
    ],
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "Html style value",
        "definition": "Indicates an HTML style that should be applied when rendering this element.",
        "comment": "This extension would be equivalent to setting the HTML \"style\" attribute on the root element for the element containing the extension.\n\nNOTE: HTML styles can include references to external content (images, fonts, etc.), which may constitute a security issue, as resolving the link can allow tracking.  See [here for more detail](http://hl7.org/fhir/security.html#narrative).\n\nFor questionnaires, see additional guidance and examples in the [SDC implementation guide](http://hl7.org/fhir/uv/sdc/2025Jan/rendering.html#rendering-style). This style applies to the base string.  If there is also a rendering-xhtml or rendering-markdown extension, they must declare any relevant styles within those extension values.\n\nSetting styles on elements can be risky.  It presumes knowledge of how elements are rendered \"by default\".  For example, setting the color of an element to 'blue' to highlight it might be fine - unless the default background color for a particular renderer is already blue.  As well, it's not a given that all elements will be represented by a single HTML element.  One element might be referenced by a collection of table cells that span rows and columns.  Setting a border style on all of those cells wouldn't give the desired results and auto-tweaking the border style on each cell (deciding whether the border is top,left, right, etc.) would require complex coding.  Finally, systems might not be using HTML for their UI at all and will need to map the specified styles to their own UI mechanism.  For this reason, this element is best used when:\na) the default UI characteristics are already well understood (because the specification applies to a single system or to a set of systems that are already required to comply with specific UI expectations\nb) the set of allowed style values is tightly controlled to only those that are necessary and sensible in that context",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Extension",
          "min": 0,
          "max": "*"
        },
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.id",
        "path": "Extension.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "Unique id for inter-element referencing",
        "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "id"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "condition": [
          "ele-1"
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Extension.extension",
        "path": "Extension.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "description": "Extensions are always sliced by (at least) url",
          "rules": "open"
        },
        "short": "Extension",
        "definition": "An Extension",
        "min": 0,
        "max": "0",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": false,
        "isSummary": false
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "representation": [
          "xmlAttr"
        ],
        "short": "identifies the meaning of the extension",
        "definition": "Source of the definition for the extension code - a logical name or a URL.",
        "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.url",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "uri"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "fixedUri": "http://hl7.org/fhir/StructureDefinition/rendering-style",
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "short": "Value of extension",
        "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.value[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "condition": [
          "ext-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "Html style value",
        "definition": "Indicates an HTML style that should be applied when rendering this element.",
        "comment": "This extension would be equivalent to setting the HTML \"style\" attribute on the root element for the element containing the extension.\n\nNOTE: HTML styles can include references to external content (images, fonts, etc.), which may constitute a security issue, as resolving the link can allow tracking.  See [here for more detail](http://hl7.org/fhir/security.html#narrative).\n\nFor questionnaires, see additional guidance and examples in the [SDC implementation guide](http://hl7.org/fhir/uv/sdc/2025Jan/rendering.html#rendering-style). This style applies to the base string.  If there is also a rendering-xhtml or rendering-markdown extension, they must declare any relevant styles within those extension values.\n\nSetting styles on elements can be risky.  It presumes knowledge of how elements are rendered \"by default\".  For example, setting the color of an element to 'blue' to highlight it might be fine - unless the default background color for a particular renderer is already blue.  As well, it's not a given that all elements will be represented by a single HTML element.  One element might be referenced by a collection of table cells that span rows and columns.  Setting a border style on all of those cells wouldn't give the desired results and auto-tweaking the border style on each cell (deciding whether the border is top,left, right, etc.) would require complex coding.  Finally, systems might not be using HTML for their UI at all and will need to map the specified styles to their own UI mechanism.  For this reason, this element is best used when:\na) the default UI characteristics are already well understood (because the specification applies to a single system or to a set of systems that are already required to comply with specific UI expectations\nb) the set of allowed style values is tightly controlled to only those that are necessary and sensible in that context",
        "min": 0,
        "max": "1",
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.extension",
        "path": "Extension.extension",
        "max": "0"
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "fixedUri": "http://hl7.org/fhir/StructureDefinition/rendering-style"
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "min": 1,
        "type": [
          {
            "code": "string"
          }
        ]
      }
    ]
  }
}