Structuredefinition-example.xml

Example of structuredefinition (id = "example")

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="example"/>
  <text><status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>url</b>: <a>http://hl7.org/fhir/StructureDefinition/example</a></p><p><b>identifier</b>: 1.2.36.90146595217.4.2</p><p><b>version</b>: 2</p><p><b>name</b>: Example Lipid Profile</p><p><b>display</b>: Example Lipid Profile</p><p><b>status</b>: draft</p><p><b>experimental</b>: true</p><p><b>publisher</b>: Health Intersections Pty Ltd</p><h3>Contacts</h3><table><tr><td>-</td><td><b>Name</b></td><td><b>Telecom</b></td></tr><tr><td>*</td><td>Grahame Grieve</td><td>grahame@healthintersections.com.au</td></tr></table><p><b>date</b>: 12/05/2012</p><p><b>description</b>: Describes how the lab report is used for a standard Lipid Profile - Cholesterol, Triglyceride
         and Cholesterol fractions. Uses LOINC codes</p><p><b>useContext</b>: ?? <span>(Details : {urn:iso:std:iso:3166 code 'AU' = '??)</span></p><p><b>requirements</b>: Provide an example to demonstrate how to use StructureDefinition</p><p><b>copyright</b>: Createive Commons 0, per FHIR specification</p><p><b>code</b>: 314079002 (Details: SNOMED CT code 314079002 = 'Hyperlipidemia screening test (procedure)',
         stated as '314079002')</p><p><b>fhirVersion</b>: 1.0.0</p><h3>Mappings</h3><table><tr><td>-</td><td><b>Identity</b></td><td><b>Uri</b></td><td><b>Name</b></td><td><b>Comments</b></td></tr><tr><td>*</td><td>m1</td><td><a>https://www.rcpa.edu.au/getattachment/0961c6d1-ec80-4500-8dc0-de516500e05b/Lipid-and-lipoprotein-tes
              ting.aspx</a></td><td>RCPA Lipid Report recommendations</td><td>Actual mappings haven't yet been filled out</td></tr></table><p><b>kind</b>: resource</p><p><b>abstract</b>: false</p><p><b>baseType</b>: DiagnosticReport</p><p><b>baseDefinition</b>: <a>http://hl7.org/fhir/StructureDefinition/DiagnosticReport</a></p><p><b>derivation</b>: constraint</p><h3>Snapshots</h3><table><tr><td>-</td><td><b>Element</b></td></tr><tr><td>*</td><td>todo-bundle</td></tr></table></div></text><url value="http://hl7.org/fhir/StructureDefinition/example"/>
  <identifier>
    <!--    for use in a CDA template Id, though this particular profile couldn't be    -->
    <system value="urn:ietf:rfc:3986"/>
    <value value="1.2.36.90146595217.4.2"/>
  </identifier>
  <version value="2"/>
  <name value="Example Lipid Profile"/>
  <!--    Quite often this has the same value as name, but not always    -->
  <display value="Example Lipid Profile"/>
  <status value="draft"/>
  <experimental value="true"/>
  <publisher value="Health Intersections Pty Ltd"/>
  <contact>
    <name value="Grahame Grieve"/>
    <telecom>
      <system value="email"/>
      <value value="grahame@healthintersections.com.au"/>
    </telecom>
  </contact>
  <date value="2012-05-12"/>
  <description value="Describes how the lab report is used for a standard Lipid Profile - Cholesterol, Triglyceride
   and Cholesterol fractions. Uses LOINC codes"/>
  <useContext>
    <!--    based on Australian recommendations    -->
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="AU"/>
    </coding>    
  </useContext>
  <requirements value="Provide an example to demonstrate how to use StructureDefinition"/><!--    0..1 Scope and Usage this structure definition is for    -->
  <copyright value="Createive Commons 0, per FHIR specification"/>
  <code>
    <system value="http://snomed.info/sct"/>
    <code value="314079002"/>
    <display value="314079002"/>
  </code>
  <fhirVersion value="1.0.0"/><!--    0..1 FHIR Version this StructureDefinition targets    -->
  <mapping> 
    <identity value="m1"/>
    <uri value="https://www.rcpa.edu.au/getattachment/0961c6d1-ec80-4500-8dc0-de516500e05b/Lipid-and-lipoprotein-tes
    ting.aspx"/>
    <name value="RCPA Lipid Report recommendations"/>
    <comments value="Actual mappings haven't yet been filled out"/>
   </mapping>
  <kind value="resource"/>
  <abstract value="false"/>
  <baseType value="DiagnosticReport"/>
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DiagnosticReport"/>
  <derivation value="constraint"/>
  <snapshot>
    <element>
      <path value="DiagnosticReport"/>
      <name value="LipidProfile"/>
      <short value="Lipid Lab Report"/>
      <definition value="The findings and interpretation of a general lipd lab profile."/>
      <comments value="In this profile, mustSupport means that authoring systems must include the ability to
       report these elements, and processing systems must cater for them by either displaying
       them to the user or considering them appropriately in decision support systems."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="DiagnosticReport"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Resource"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element>
      <path value="DiagnosticReport.extension"/>
      <slicing>
        <discriminator value="url"/>
        <ordered value="false"/>
        <rules value="open"/>
      </slicing>
      <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 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."/>
      <comments 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 simplicity
       for everyone."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="DiagnosticReport.extension"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Extension"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element>
      <path value="DiagnosticReport.text"/>
      <short value="Text summary of the resource, for human interpretation"/>
      <definition value="A human-readable narrative that contains a summary of the resource, and may be used to
       represent the content of the resource to a human. The narrative need not encode all the
       structured data, but is required to contain sufficient detail to make it &quot;clinically
       safe&quot; for a human to just read the narrative. Resource definitions may define what
       content should be represented in the narrative to ensure clinical safety."/>
      <comments value="Contained resources do not have narrative. Resources that are not contained SHOULD have
       a narrative."/>
      <alias value="narrative"/>
      <alias value="html"/>
      <alias value="xhtml"/>
      <alias value="display"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="DiagnosticReport.text"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Narrative"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element>
      <path value="DiagnosticReport.contained"/>
      <short value="Contained, inline Resources"/>
      <definition value="These resources do not have an independent existence apart from the resource that contains
       them - they cannot be identified independently, and nor can they have their own independent
       transaction scope."/>
      <comments value="This should never be done when the content can be identified properly, as once identification
       is lost, it is extremely difficult (and context dependent) to restore it again."/>
      <alias value="inline resources"/>
      <alias value="anonymous resources"/>
      <alias value="contained resources"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="DiagnosticReport.contained"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Resource"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element>
      <path value="DiagnosticReport.status"/>
      <short value="registered|interim|final|amended|cancelled|withdrawn"/>
      <definition value="The status of the diagnostic report as a whole."/>
      <comments value="This is labeled as &quot;Is Modifier&quot; because applications need to take appropriate
       action if a report is withdrawn."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="DiagnosticReport.status"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="code"/>
      </type>
      <isModifier value="false"/>
      <binding>
        <strength value="required"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/observation-status"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="DiagnosticReport.issued"/>
      <short value="Date this version was released"/>
      <definition value="The date and/or time that this version of the report was released from the source diagnostic
       service."/>
      <comments value="May be different from the update time of the resource itself, because that is the status
       of the record (potentially a secondary copy), not the actual release time of the report."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="DiagnosticReport.issued"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="dateTime"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element>
      <path value="DiagnosticReport.subject"/>
      <short value="The subject of the report"/>
      <definition value="The subject of the report. Usually, but not always, this is a patient. However diagnostic
       services also perform analyses on specimens collected from a variety of other sources."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="DiagnosticReport.subject"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Patient"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Group"/>
      </type>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Device"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element>
      <path value="DiagnosticReport.performer"/>
      <short value="Responsible Diagnostic Service"/>
      <definition value="The diagnostic service that is responsible for issuing the report."/>
      <comments value="This is not necessarily the source of the atomic data items - it's the entity that takes
       responsibility for the clinical report."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="DiagnosticReport.performer"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Observation"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element>
      <path value="DiagnosticReport.identifier"/>
      <short value="Id for external references to this report"/>
      <definition value="The local ID assigned to the report by the order filler, usually by the Information System
       of the diagnostic service provider."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="DiagnosticReport.identifier"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Identifier"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element>
      <path value="DiagnosticReport.request"/>
      <short value="What was requested"/>
      <definition value="Details concerning a single pathology test requested."/>
      <comments value="Note: Usually there is one test request for each result, however in some circumstances
       multiple test requests may be represented using a single Pathology test result resource.
       Note that there are also cases where one request leads to multiple reports."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="DiagnosticReport.request"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/DiagnosticOrder"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element>
      <path value="DiagnosticReport.category"/>
      <short value="Biochemistry, Haematology etc."/>
      <definition value="The section of the diagnostic service that performs the examination e.g. biochemistry,
       haematology, MRI."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="DiagnosticReport.category"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="CodeableConcept"/>
      </type>
      <isModifier value="false"/>
      <binding>
        <strength value="preferred"/>
        <valueSetReference>
          <reference value="http://hl7.org/fhir/ValueSet/diagnostic-service-sections"/>
        </valueSetReference>
      </binding>
    </element>
    <element>
      <path value="DiagnosticReport.effectiveDateTime"/>
      <short value="Diagnostically relevant time of diagnostic report"/>
      <definition value="The diagnostically relevant time for this report - that is, the point in time at which
       the observations that are reported in this diagnostic report relate to the patient."/>
      <comments value="If the diagnostic procedure was performed on the patient, this is the time it was performed.
       If there is specimens, the diagnostically relevant time can be derived from the specimen
       collection times, but the specimen information is not always available, and the exact
       relationship between the specimens and the diagnostically relevant time is not always
       automatic."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="DiagnosticReport.effective[x]"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="dateTime"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element>
      <path value="DiagnosticReport.result"/>
      <slicing>
        <discriminator value="reference.code"/>
        <ordered value="false"/>
        <rules value="open"/>
      </slicing>
      <short value="Lipid Lab Results"/>
      <definition value="Lipid Lab Results."/>
      <min value="4"/>
      <max value="4"/>
      <base>
        <path value="DiagnosticReport.result"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/Observation"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element>
      <path value="DiagnosticReport.result"/>
      <name value="Cholesterol"/>
      <short value="Cholesterol Result"/>
      <definition value="Reference to Cholesterol Result."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="DiagnosticReport.result"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/cholesterol"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element>
      <path value="DiagnosticReport.result"/>
      <name value="Triglyceride"/>
      <short value="Triglyceride Result"/>
      <definition value="Group of elements for Triglyceride result."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="DiagnosticReport.result"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/triglyceride"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element>
      <path value="DiagnosticReport.result"/>
      <name value="HDL Cholesterol"/>
      <short value="HDL Cholesterol Result"/>
      <definition value="Group of elements for HDL Cholesterol result."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="DiagnosticReport.result"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/hdlcholesterol"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element>
      <path value="DiagnosticReport.result"/>
      <name value="LDL Cholesterol"/>
      <short value="LDL Cholesterol result, if reported"/>
      <definition value="LDL Cholesterol result, if reported."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="DiagnosticReport.result"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Reference"/>
        <profile value="http://hl7.org/fhir/StructureDefinition/ldlcholesterol"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element>
      <path value="DiagnosticReport.conclusion"/>
      <short value="Clinical Interpretation of Lipid Panel"/>
      <definition value="May include diagnosis or suggestions for follow up testing."/>
      <comments value="It's not unusual for the lab to make some kind of interpretative comment on the set of
       results."/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="DiagnosticReport.conclusion"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="string"/>
      </type>
      <isModifier value="false"/>
    </element>
    <element>
      <path value="DiagnosticReport.representation"/>
      <short value="Entire Report as issued"/>
      <definition value="Rich text representation of the entire result as issued by the diagnostic service. Multiple
       formats are allowed but they SHALL be semantically equivalent."/>
      <comments value="Possible formats: text/html, text/plain, text/rtf, application/msword, application/pdf,
       application/rtf, application/vnd.oasis.opendocument.text, application/vnd.openxmlformats-officedocum
      ent.wordprocessingml.document. Application/pdf is recommended as the most reliable and
       interoperable in this context."/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="DiagnosticReport.representation"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="Attachment"/>
      </type>
      <isModifier value="false"/>
    </element>
  </snapshot>
</StructureDefinition>