Other.profile.xml

Profile for other

Raw XML

<Profile xmlns="http://hl7.org/fhir">
  <text>
    <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><pre>
&lt;<a class="dict" href="other-definitions.html#Other" title="Other is a conformant for handling resource concepts not yet defined for FHIR or outside
         HL7's scope of interest."><b>Other</b></a> xmlns=&quot;http://hl7.org/fhir&quot;&gt; <span style="float: right"><a href="formats.html" title="Documentation for this format"><img alt="doco" src="help.png"/></a></span>
 &lt;!-- from <a href="resources.html">Resource</a>: <a href="extensibility.html">extension</a>, <a href="extensibility.html#modifierExtension">modifierExtension</a>, language, <a href="narrative.html#Narrative">text</a>, and <a href="references.html#contained">contained</a> --&gt;
 &lt;<a class="dict" href="other-definitions.html#Other.identifier" title="Identifier assigned to the resource for business purposes, outside the context of FHIR."><b>identifier</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..*</b></span> <span style="color: darkgreen"><a href="datatypes.html#Identifier">Identifier</a></span> <span style="color: navy">Business identifier</span><span style="color: Gray"> --&gt;</span>&lt;/identifier&gt;
 &lt;<a class="dict" href="other-definitions.html#Other.code" title="Identifies the 'type' of resource - equivalent to the resource name for other resources
         (this element modifies the meaning of other elements)"><span style="text-decoration: underline"><b>code</b></span></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <span style="color: navy"><a href="valueset-other-resource-type.html" style="color: navy">Kind of Resource</a></span><span style="color: Gray"> --&gt;</span>&lt;/code&gt;
 &lt;<a class="dict" href="other-definitions.html#Other.subject" title="Identifies the patient, practitioner, device or any other resource that is the &quot;focus&quot;
         of this resoruce."><b>subject</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="resourcelist.html">Any</a>)</span> <span style="color: navy">Identifies the</span><span style="color: Gray"> --&gt;</span>&lt;/subject&gt;
 &lt;<a class="dict" href="other-definitions.html#Other.author" title="Indicates who was responsible for creating the resource instance."><b>author</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="practitioner.html#Practitioner">Practitioner</a>|<a href="patient.html#Patient">Patient</a>|<a href="relatedperson.html#RelatedPerson">RelatedPerson</a>)</span> <span style="color: navy">Who created</span><span style="color: Gray"> --&gt;</span>&lt;/author&gt;
 &lt;<a class="dict" href="other-definitions.html#Other.created" title="Identifies when the resource was first created."><b>created</b></a> value=&quot;[<span style="color: darkgreen"><a href="datatypes.html#date">date</a></span>]&quot;/&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: navy">When created</span><span style="color: Gray"> --&gt;</span>
&lt;/Other&gt;
</pre></div>
  </text>
  <name value="other"/>
  <publisher value="FHIR Project"/>
  <description value="Basic Profile. Other is a conformant for handling resource concepts not yet defined for
   FHIR or outside HL7's scope of interest."/>
  <status value="draft"/>
  <date value="2014-09-30"/>
  <requirements value="Scope and Usage Other is a special type of resource. Unlike all other resources, it doesn't
   correspond to a specific identifiable real-world concept. Instead, it's a placeholder
   for any resource-like concept that isn't already defined in the HL7 specification.   The
   Other resource is intended for use in two circumstances:   * When an implementer needs
   a resource concept that is likely to be defined by HL7 in the future but they have not
   yet done so (due to bandwidth issues, lack of sufficient requirements, lower prioritization,
   etc.) * When the resource concept falls &quot;outside the 99%&quot; - i.e. less than 1%
   of the systems that use FHIR are likely to ever make use of the resource. To keep the
   specification manageable, it cannot incorporate every esoteric requirement that might
   be needed in some implementation somewhere. This set of resources likely won't ever be
   officially defined in HL7. There's also a third circumstance: An implementer wishes to
   convey information that could/should be conveyed using a standard resource, however they
   want to represent the information in a custom format that isn't aligned with the official
   resource's elements. While this resource would be the preferred way of meeting that use-case
   because it will at least be wire-format compatible, such a use would not be conformant
   because making use of the Other resource would prevent the healthcare-related information
   from being safely processed, queried and analyzed by other conformant systems.   Implementers
   don't really need to be concerned with one of the two categories their desired resource
   fits within. If they need a resource and it doesn't yet exist, they should use Other."/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <structure>
    <type value="Other"/>
    <publish value="true"/>
    <element>
      <path value="Other"/>
      <definition>
        <short value="Resource for non-supported content"/>
        <formal value="Other is a conformant for handling resource concepts not yet defined for FHIR or outside
         HL7's scope of interest."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="Resource"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value="Act, Entity or Role"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="Other.extension"/>
      <definition>
        <short value="Additional Content defined by implementations"/>
        <formal 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."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="Other.modifierExtension"/>
      <definition>
        <short value="Extensions that cannot be ignored"/>
        <formal value="May be used to represent additional information that is not part of the basic definition
         of the resource, and that modifies the understanding of the element that contains it.
         Usually modifier elements provide negation or qualification. 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.
         Applications processing a resource are required to check for modifier extensions."/>
        <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."/>
        <synonym value="extensions"/>
        <synonym value="user content"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Extension"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="Other.text"/>
      <definition>
        <short value="Text summary of the resource, for human interpretation"/>
        <formal 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."/>
        <synonym value="narrative"/>
        <synonym value="html"/>
        <synonym value="xhtml"/>
        <synonym value="display"/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="Narrative"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="Other.contained"/>
      <definition>
        <short value="Contained, inline Resources"/>
        <formal 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."/>
        <synonym value="inline resources"/>
        <synonym value="anonymous resources"/>
        <synonym value="contained resources"/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Resource"/>
        </type>
        <isModifier value="false"/>
      </definition>
    </element>
    <element>
      <path value="Other.identifier"/>
      <definition>
        <short value="Business identifier"/>
        <formal value="Identifier assigned to the resource for business purposes, outside the context of FHIR."/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Identifier"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value="./identifier"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="Other.code"/>
      <definition>
        <short value="Kind of Resource"/>
        <formal value="Identifies the 'type' of resource - equivalent to the resource name for other resources."/>
        <comments value="Because resource references will only be able to indicate 'Other', the type of reference
         will need to be specified in a Profile identified as part of the resource.  Refer to the
         resource notes section for information on appropriate terminologies for this code."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="CodeableConcept"/>
        </type>
        <isModifier value="true"/>
        <binding>
          <name value="OtherResourceType"/>
          <isExtensible value="true"/>
          <conformance value="example"/>
          <referenceResource>
            <reference value="http://hl7.org/fhir/vs/other-resource-type"/>
          </referenceResource>
        </binding>
        <mapping>
          <identity value="rim"/>
          <map value="./code"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="Other.subject"/>
      <definition>
        <short value="Identifies the"/>
        <formal value="Identifies the patient, practitioner, device or any other resource that is the &quot;focus&quot;
         of this resoruce."/>
        <comments value="Optional as not all resources potential resources will have subjects.  Resources associated
         with multiple subjects can handle this via extension."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="ResourceReference"/>
          <profile value="http://hl7.org/fhir/profiles/Any"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value="./participation[typeCode='SBJ'] (possibly through a ControlAct and Role)"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="Other.author"/>
      <definition>
        <short value="Who created"/>
        <formal value="Indicates who was responsible for creating the resource instance."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="ResourceReference"/>
          <profile value="http://hl7.org/fhir/profiles/Practitioner"/>
        </type>
        <type>
          <code value="ResourceReference"/>
          <profile value="http://hl7.org/fhir/profiles/Patient"/>
        </type>
        <type>
          <code value="ResourceReference"/>
          <profile value="http://hl7.org/fhir/profiles/RelatedPerson"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value="./participation[typeCode='SUB'] (possibly through a ControlAct and Role)"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="Other.created"/>
      <definition>
        <short value="When created"/>
        <formal value="Identifies when the resource was first created."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="date"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value="./participation[typeCode='AUT']/time (possibly through a ControlAct and Role)"/>
        </mapping>
      </definition>
    </element>
    <searchParam>
      <name value="_id"/>
      <type value="token"/>
      <documentation value="The logical resource id associated with the resource (must be supported by all servers)"/>
    </searchParam>
    <searchParam>
      <name value="_language"/>
      <type value="token"/>
      <documentation value="The language of the resource"/>
    </searchParam>
    <searchParam>
      <name value="code"/>
      <type value="token"/>
      <documentation value="Kind of Resource"/>
      <xpath value="f:Other/f:code"/>
    </searchParam>
    <searchParam>
      <name value="created"/>
      <type value="date"/>
      <documentation value="When created"/>
      <xpath value="f:Other/f:created"/>
    </searchParam>
    <searchParam>
      <name value="subject"/>
      <type value="reference"/>
      <documentation value="Identifies the"/>
      <xpath value="f:Other/f:subject"/>
    </searchParam>
  </structure>
</Profile>