Alert.profile.xml

Profile for alert

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="alert-definitions.html#Alert" title="Prospective warnings of potential issues when providing care to the patient."><b>Alert</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="alert-definitions.html#Alert.identifier" title="Identifier assigned to the alert for external use (outside the FHIR environment)."><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="alert-definitions.html#Alert.category" title="Allows an alert to be divided into different categories like clinical, administrative
         etc."><b>category</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>0..1</b></span> <span style="color: darkgreen"><a href="datatypes.html#CodeableConcept">CodeableConcept</a></span> <span style="color: navy">Clinical, administrative, etc.</span><span style="color: Gray"> --&gt;</span>&lt;/category&gt;
 &lt;<a class="dict" href="alert-definitions.html#Alert.status" title="Supports basic workflow."><b>status</b></a> value=&quot;[<span style="color: darkgreen"><a href="datatypes.html#code">code</a></span>]&quot;/&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy"><a href="alert-status.html" style="color: navy">active | inactive | entered in error</a></span><span style="color: Gray"> --&gt;</span>
 &lt;<a class="dict" href="alert-definitions.html#Alert.subject" title="The person who this alert concerns."><b>subject</b></a>&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: darkgreen"><a href="references.html#Resource">Resource</a>(<a href="patient.html#Patient">Patient</a>)</span> <span style="color: navy">Who is alert about?</span><span style="color: Gray"> --&gt;</span>&lt;/subject&gt;
 &lt;<a class="dict" href="alert-definitions.html#Alert.author" title="The person or device that created the alert."><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="device.html#Device">Device</a>)</span> <span style="color: navy">Alert creator</span><span style="color: Gray"> --&gt;</span>&lt;/author&gt;
 &lt;<a class="dict" href="alert-definitions.html#Alert.note" title="The textual component of the alert to display to the user."><b>note</b></a> value=&quot;[<span style="color: darkgreen"><a href="datatypes.html#string">string</a></span>]&quot;/&gt;<span style="color: Gray">&lt;!--</span> <span style="color: brown"><b>1..1</b></span> <span style="color: navy">Text of alert</span><span style="color: Gray"> --&gt;</span>
&lt;/Alert&gt;
</pre></div>
  </text>
  <name value="alert"/>
  <publisher value="FHIR Project"/>
  <description value="Basic Profile. Prospective warnings of potential issues when providing care to the patient."/>
  <status value="draft"/>
  <date value="2014-09-30"/>
  <requirements value="Scope and Usage The Alert resource provides a single interface for managing clinical and
   administrative facts that need to be brought to the attention of users of clinical systems.
   Examples can include many things. Patient's posing particular risks (falls, physical violence),
   patient's needing special accomodations (hard of hearing, use easy-open caps), administrative
   concerns (verify postal address, pre-payment required) or any other situation that needs
   to be brought to attention within the context of a particular workflow. (The workflow
   relevant to the issue can be identified by the category element.)   Usually, resources
   specific to particular types of issues (health conditions, allergies, active medications
   will be used to communicate those issues. However, in some cases, particularly important
   information (a latex or severe food allergy) migt be highlighted as an Alert as well as
   the more typical resource."/>
  <mapping>
    <identity value="rim"/>
    <uri value="http://hl7.org/v3"/>
    <name value="RIM"/>
  </mapping>
  <structure>
    <type value="Alert"/>
    <publish value="true"/>
    <element>
      <path value="Alert"/>
      <definition>
        <short value="Key information to flag to healthcare providers"/>
        <formal value="Prospective warnings of potential issues when providing care to the patient."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="Resource"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value="Observation[classCode=ISSUE, moodCode=EVN]"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="Alert.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="Alert.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="Alert.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="Alert.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="Alert.identifier"/>
      <definition>
        <short value="Business identifier"/>
        <formal value="Identifier assigned to the alert for external use (outside the FHIR environment)."/>
        <min value="0"/>
        <max value="*"/>
        <type>
          <code value="Identifier"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".id"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="Alert.category"/>
      <definition>
        <short value="Clinical, administrative, etc."/>
        <formal value="Allows an alert to be divided into different categories like clinical, administrative
         etc."/>
        <min value="0"/>
        <max value="1"/>
        <type>
          <code value="CodeableConcept"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".code"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="Alert.status"/>
      <definition>
        <short value="active | inactive | entered in error"/>
        <formal value="Supports basic workflow."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="code"/>
        </type>
        <isModifier value="false"/>
        <binding>
          <name value="AlertStatus"/>
          <isExtensible value="false"/>
          <conformance value="required"/>
          <referenceResource>
            <reference value="http://hl7.org/fhir/vs/alert-status"/>
          </referenceResource>
        </binding>
        <mapping>
          <identity value="rim"/>
          <map value=".status"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="Alert.subject"/>
      <definition>
        <short value="Who is alert about?"/>
        <formal value="The person who this alert concerns."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="ResourceReference"/>
          <profile value="http://hl7.org/fhir/profiles/Patient"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".participation[typeCode=SBJ].role[classCode=PAT]"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="Alert.author"/>
      <definition>
        <short value="Alert creator"/>
        <formal value="The person or device that created the alert."/>
        <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/Device"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".participation[typeCode=AUT].role"/>
        </mapping>
      </definition>
    </element>
    <element>
      <path value="Alert.note"/>
      <definition>
        <short value="Text of alert"/>
        <formal value="The textual component of the alert to display to the user."/>
        <min value="1"/>
        <max value="1"/>
        <type>
          <code value="string"/>
        </type>
        <isModifier value="false"/>
        <mapping>
          <identity value="rim"/>
          <map value=".value"/>
        </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="subject"/>
      <type value="reference"/>
      <documentation value="The identity of a subject to list alerts for"/>
      <xpath value="f:Alert/f:subject"/>
    </searchParam>
  </structure>
</Profile>