FHIR Release 3 (STU) 4

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

Markdown.profile.xml

Modeling and Methodology Work Group Maturity Level : N/A Ballot Standards Status : Informative

Raw XML ( canonical form + also see XML Format Specification )

StructureDefinition for markdown

<?xml version="1.0" encoding="UTF-8"?>


<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="markdown"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">to do</div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="normative"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
    <valueCode value="4.0.0"/> 
  </extension> 
  <url value="http://hl7.org/fhir/StructureDefinition/markdown"/> 
  <version value="4.0.1"/> 
  <name value="markdown"/> 
  
  

  <status value="active"/> 
  <date value="2019-11-01T09:29:23+11:00"/> 
  <publisher value="HL7 FHIR Standard"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
  </contact> 
  Base StructureDefinition for markdown type: A string that may contain markdown syntax
   for optional processing by a mark down presentation engine
  

  <description value="Base StructureDefinition for markdown type: A string that may contain Github Flavored
   Markdown syntax for optional processing by a mark down presentation engine"/> 
  <fhirVersion value="4.0.1"/> 
  <kind value="primitive-type"/> 
  <abstract value="false"/> 
  <type value="markdown"/> 
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/string"/> 
  <derivation value="specialization"/> 
  <snapshot> 
    <element id="markdown">
      <path value="markdown"/> 
      <short value="Primitive Type markdown"/> 
      A string that may contain markdown syntax for optional processing by a mark down presentation
       engine
      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)

      <definition value="A string that may contain Github Flavored Markdown syntax for optional processing by a
       mark down presentation engine"/> 
      <comment value="Systems are not required to have markdown support, so the text should be readable without

       markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/"/> 

      <min value="0"/> 
      <max value="*"/> 
      <base> 
        <path value="markdown"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        

        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        

        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="markdown.id">
      <path value="markdown.id"/> 
      <representation value="xmlAttr"/> 
      <short value="xml:id (or equivalent in JSON)"/> 
      <definition value="unique id for the element within a resource (for internal references)"/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="Element.id"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
    <!--  Note: special primitive values have a FHIRPath system type. e.g. this is compiler magic
       (h)  -->

      <type> 
        

        <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUrl value="string"/> 
        </extension> 
        <code value="http://hl7.org/fhirpath/System.String"/> 
      </type> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="markdown.extension">
      <path value="markdown.extension"/> 
      

      <short value="Additional content defined by implementations"/> 
      <definition value="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.

       of the resource. 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."/> 

      <comment 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."/> 
      <alias value="extensions"/> 
      <alias value="user content"/> 
      <min value="0"/> 
      <max value="*"/> 
      <base> 
        <path value="Element.extension"/> 
        <min value="0"/> 
        <max value="*"/> 
      </base> 
      <type> 
        <code value="Extension"/> 
      </type> 
      <constraint> 
        <key value="ele-1"/> 
        <severity value="error"/> 
        <human value="All FHIR elements must have a @value or children"/> 
        <expression value="hasValue() or (children().count() &gt; id.count())"/> 
        <xpath value="@value|f:*|h:div"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Element"/> 
      </constraint> 
      <constraint> 
        <key value="ext-1"/> 
        <severity value="error"/> 
        <human value="Must have either extensions or value[x], not both"/> 
        <expression value="extension.exists() != value.exists()"/> 
        <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"/> 
        <source value="http://hl7.org/fhir/StructureDefinition/Extension"/> 
      </constraint> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
    <element id="markdown.value">
      <path value="markdown.value"/> 
      <representation value="xmlAttr"/> 
      <short value="Primitive value for markdown"/> 
      <definition value="Primitive value for markdown"/> 
      <min value="0"/> 
      <max value="1"/> 
      <base> 
        <path value="string.value"/> 
        <min value="0"/> 
        <max value="1"/> 
      </base> 
    <!--  Note: primitive values do not have an assigned type. e.g. this is compiler magic. XML,
       JSON and RDF types provided by extension  -->

    <!--  Note: special primitive values have a FHIRPath system type. e.g. this is compiler magic
       (i)  -->

      <type> 
        
          
            
          
          
            
          
          
            
          
        

        <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUrl value="string"/> 
        </extension> 
        <extension url="http://hl7.org/fhir/StructureDefinition/regex">
          <valueString value="[ \r\n\t\S]+"/> 
        </extension> 
        <code value="http://hl7.org/fhirpath/System.String"/> 
      </type> 
      <isModifier value="false"/> 
      <isSummary value="false"/> 
    </element> 
  </snapshot> 
  <differential> 
    <element id="markdown">
      <path value="markdown"/> 
      <short value="Primitive Type markdown"/> 
      A string that may contain markdown syntax for optional processing by a mark down presentation
       engine
      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)

      <definition value="A string that may contain Github Flavored Markdown syntax for optional processing by a
       mark down presentation engine"/> 
      <comment value="Systems are not required to have markdown support, so the text should be readable without

       markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/"/> 

      <min value="0"/> 
      <max value="*"/> 
    </element> 
    <element id="markdown.value">
      <path value="markdown.value"/> 
      <representation value="xmlAttr"/> 
      <short value="Primitive value for markdown"/> 
      <definition value="Primitive value for markdown"/> 
      <min value="0"/> 
      <max value="1"/> 
    <!--  Note: primitive values do not have an assigned type. e.g. this is compiler magic. XML,
       JSON and RDF types provided by extension  -->

    <!--  Note: special primitive values have a FHIRPath system type. e.g. this is compiler magic
       (g)  -->

      <type> 
        
          
            
          
          
            
          
          
            
          
        

        <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
          <valueUrl value="markdown"/> 
        </extension> 
        <extension url="http://hl7.org/fhir/StructureDefinition/regex">
          <valueString value="[ \r\n\t\S]+"/> 
        </extension> 
        <code value="http://hl7.org/fhirpath/System.String"/> 
      </type> 
    </element> 
  </differential> 


</

StructureDefinition

>



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.