FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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 R3 R2

Markdown.profile.json

Modeling and Methodology Work GroupMaturity Level: N/ABallot Status: Informative

Raw JSON (canonical form)

StructureDefinition for markdown

{
  "resourceType": "StructureDefinition",
  "id": "markdown",
  "meta": {
    "lastUpdated": "2019-10-24T11:53:00+11:00"
  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/StructureDefinition/markdown",
  "name": "markdown",
  "status": "draft",
  "date": "2019-10-24T11:53:00+11:00",
  "publisher": "HL7 FHIR Standard",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "description": "Base StructureDefinition for markdown type: A string that may contain markdown syntax for optional processing by a mark down presentation engine",
  "fhirVersion": "3.0.2",
  "kind": "primitive-type",
  "abstract": false,
  "type": "markdown",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/string",
  "derivation": "specialization",
  "snapshot": {
    "element": [
      {
        "id": "markdown",
        "path": "markdown",
        "short": "Primitive Type markdown",
        "definition": "A string that may contain markdown syntax for optional processing by a mark down presentation engine",
        "comment": "Systems are not required to have markdown support, and there is considerable variation in markdown syntax, so the text should be readable without markdown processing. The preferred markdown syntax is described here: http://daringfireball.net/projects/markdown/syntax (and tests here: http://daringfireball.net/projects/downloads/MarkdownTest_1.0.zip)",
        "min": 0,
        "max": "*",
        "base": {
          "path": "markdown",
          "min": 0,
          "max": "*"
        },
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() | (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "Element"
          }
        ]
      },
      {
        "id": "markdown.id",
        "path": "markdown.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "xml:id (or equivalent in JSON)",
        "definition": "unique id for the element within a resource (for internal references)",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "markdown.extension",
        "path": "markdown.extension",
        "short": "Additional Content defined by implementations",
        "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the 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.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ]
      },
      {
        "id": "markdown.value",
        "path": "markdown.value",
        "representation": [
          "xmlAttr"
        ],
        "short": "Primitive value for markdown",
        "definition": "Primitive value for markdown",
        "min": 0,
        "max": "1",
        "base": {
          "path": "string.value",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "_code": {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
                  "valueString": "string"
                },
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
                  "valueString": "xsd:string"
                },
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
                  "valueString": "xsd:string"
                }
              ]
            }
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "markdown",
        "path": "markdown",
        "short": "Primitive Type markdown",
        "definition": "A string that may contain markdown syntax for optional processing by a mark down presentation engine",
        "comment": "Systems are not required to have markdown support, and there is considerable variation in markdown syntax, so the text should be readable without markdown processing. The preferred markdown syntax is described here: http://daringfireball.net/projects/markdown/syntax (and tests here: http://daringfireball.net/projects/downloads/MarkdownTest_1.0.zip)",
        "min": 0,
        "max": "*"
      },
      {
        "id": "markdown.value",
        "path": "markdown.value",
        "representation": [
          "xmlAttr"
        ],
        "short": "Primitive value for markdown",
        "definition": "Primitive value for markdown",
        "min": 0,
        "max": "1",
        "type": [
          {
            "_code": {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
                  "valueString": "string"
                },
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
                  "valueString": "xsd:string"
                },
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
                  "valueString": "xsd:string"
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

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.