STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 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

Cts2/RESTResource.xml

Raw XML (canonical form)

Logical Model RESTResource

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="RESTResource"/>
  <url value="{http://www.omg.org/spec/CTS2/1.1/Core}RESTResource"/>
  <name value="RESTResource"/>
  <display value="CTS2.RESTResource"/>
  <status value="draft"/>
  <publisher value="Generated by Xsd-to-FHIR"/>
  <contact>
    <name value="Visit the Github repository for more information"/>
    <telecom>
      <system value="other"/>
      <value value="https://github.com/cts2/CTS2-to-FHIR"/>
    </telecom>
  </contact>
  <date value="2016-02-08T19:11:02-07:00"/>
  <description value="The header information for any REST resource retrieval"/>
  <fhirVersion value="1.4.0"/>
  <kind value="logical"/>
  <abstract value="false"/>
  <snapshot>
    <element>
      <path value="RESTResource"/>
      <short value="RESTResource"/>
      <definition value="The header information for any REST resource retrieval"/>
      <min value="0"/>
      <max value="*"/>
    </element>
    <element>
      <path value="RESTResource.resourceRoot"/>
      <name value="resourceRoot"/>
      <short value="The URI of the REST service"/>
      <definition value="The URI of the REST service.  As an example, if the resource URI       was &quot;http://informatics.
      mayo.edu/cts2/rest/codesystems&quot;, the resourceRoot would be       &quot;http://informatics.mayo.e
      du/cts2/rest/&quot;"/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="ServiceURI"/>
      </type>
    </element>
    <element>
      <path value="RESTResource.resourceURI"/>
      <name value="resourceURI"/>
      <short value="The relative URI of the resource with respect to the resourceRoot"/>
      <definition value="The relative URI of the resource with respect to the resourceRoot.  As an example,   
          if the resource URI was &quot;http://informatics.mayo.edu/cts2/rest/codesystems&quot;,
       the resourceURI would       be &quot;codesystems&quot;.  Fragment and query identifiers
       should also be included."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="RenderingURI"/>
      </type>
    </element>
    <element>
      <path value="RESTResource.parameter"/>
      <name value="parameter"/>
      <short value="The paramaters that were used in executing the query"/>
      <definition value="The paramaters that were used in executing the query. This carries all of the parameters
       that      are needed to reconstruct the complete query in either a RESTful or procedural
       environment. The service provider      may or may not include non-CTS2 related parameters
       such as security tokens, routing requests, etc."/>
      <min value="0"/>
      <max value="*"/>
      <type>
        <code value="Parameter"/>
      </type>
    </element>
    <element>
      <path value="RESTResource.accessDate"/>
      <name value="accessDate"/>
      <short value="The date and time that the resource was accessed"/>
      <definition value="The date and time that the resource was accessed."/>
      <min value="1"/>
      <max value="1"/>
      <type>
        <code value="DateAndTime"/>
      </type>
    </element>
  </snapshot>
</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.