Alert.profile.xml

Profile for alert

{
  "resourceType": "Profile",
  "text": {
    "status": "generated",
    "div": "<div><pre>\r\n&lt;<a title=\"Prospective warnings of potential issues when providing care to the patient.\" class=\"dict\" href=\"alert-definitions.html#Alert\"><b>Alert</b></a> xmlns=&quot;http://hl7.org/fhir&quot;&gt; <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n &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;\r\n &lt;<a title=\"Identifier assigned to the alert for external use (outside the FHIR environment).\" class=\"dict\" href=\"alert-definitions.html#Alert.identifier\"><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;\r\n &lt;<a title=\"Allows an alert to be divided into different categories like clinical, administrative etc.\" class=\"dict\" href=\"alert-definitions.html#Alert.category\"><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;\r\n &lt;<a title=\"Supports basic workflow.\" class=\"dict\" href=\"alert-definitions.html#Alert.status\"><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 style=\"color: navy\" href=\"alert-status.html\">active | inactive | entered in error</a></span><span style=\"color: Gray\"> --&gt;</span>\r\n &lt;<a title=\"The person who this alert concerns.\" class=\"dict\" href=\"alert-definitions.html#Alert.subject\"><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;\r\n &lt;<a title=\"The person or device that created the alert.\" class=\"dict\" href=\"alert-definitions.html#Alert.author\"><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;\r\n &lt;<a title=\"The textual component of the alert to display to the user.\" class=\"dict\" href=\"alert-definitions.html#Alert.note\"><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>\r\n&lt;/Alert&gt;\r\n</pre></div>"
  },
  "name": "alert",
  "publisher": "FHIR Project",
  "description": "Basic Profile. Prospective warnings of potential issues when providing care to the patient.",
  "status": "draft",
  "date": "2014-09-30",
  "requirements": "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.) \r\n\r\nUsually, 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": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM"
    }
  ],
  "structure": [
    {
      "type": "Alert",
      "publish": true,
      "element": [
        {
          "path": "Alert",
          "definition": {
            "short": "Key information to flag to healthcare providers",
            "formal": "Prospective warnings of potential issues when providing care to the patient.",
            "min": 1,
            "max": "1",
            "type": [
              {
                "code": "Resource"
              }
            ],
            "isModifier": false,
            "mapping": [
              {
                "identity": "rim",
                "map": "Observation[classCode=ISSUE, moodCode=EVN]"
              }
            ]
          }
        },
        {
          "path": "Alert.extension",
          "definition": {
            "short": "Additional Content defined by implementations",
            "formal": "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": "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": [
              "extensions",
              "user content"
            ],
            "min": 0,
            "max": "*",
            "type": [
              {
                "code": "Extension"
              }
            ],
            "isModifier": false
          }
        },
        {
          "path": "Alert.modifierExtension",
          "definition": {
            "short": "Extensions that cannot be ignored",
            "formal": "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": "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": [
              "extensions",
              "user content"
            ],
            "min": 0,
            "max": "*",
            "type": [
              {
                "code": "Extension"
              }
            ],
            "isModifier": false
          }
        },
        {
          "path": "Alert.text",
          "definition": {
            "short": "Text summary of the resource, for human interpretation",
            "formal": "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 \"clinically safe\" 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": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
            "synonym": [
              "narrative",
              "html",
              "xhtml",
              "display"
            ],
            "min": 0,
            "max": "1",
            "type": [
              {
                "code": "Narrative"
              }
            ],
            "isModifier": false
          }
        },
        {
          "path": "Alert.contained",
          "definition": {
            "short": "Contained, inline Resources",
            "formal": "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": "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": [
              "inline resources",
              "anonymous resources",
              "contained resources"
            ],
            "min": 0,
            "max": "*",
            "type": [
              {
                "code": "Resource"
              }
            ],
            "isModifier": false
          }
        },
        {
          "path": "Alert.identifier",
          "definition": {
            "short": "Business identifier",
            "formal": "Identifier assigned to the alert for external use (outside the FHIR environment).",
            "min": 0,
            "max": "*",
            "type": [
              {
                "code": "Identifier"
              }
            ],
            "isModifier": false,
            "mapping": [
              {
                "identity": "rim",
                "map": ".id"
              }
            ]
          }
        },
        {
          "path": "Alert.category",
          "definition": {
            "short": "Clinical, administrative, etc.",
            "formal": "Allows an alert to be divided into different categories like clinical, administrative etc.",
            "min": 0,
            "max": "1",
            "type": [
              {
                "code": "CodeableConcept"
              }
            ],
            "isModifier": false,
            "mapping": [
              {
                "identity": "rim",
                "map": ".code"
              }
            ]
          }
        },
        {
          "path": "Alert.status",
          "definition": {
            "short": "active | inactive | entered in error",
            "formal": "Supports basic workflow.",
            "min": 1,
            "max": "1",
            "type": [
              {
                "code": "code"
              }
            ],
            "isModifier": false,
            "binding": {
              "name": "AlertStatus",
              "isExtensible": false,
              "conformance": "required",
              "referenceResource": {
                "reference": "http://hl7.org/fhir/vs/alert-status"
              }
            },
            "mapping": [
              {
                "identity": "rim",
                "map": ".status"
              }
            ]
          }
        },
        {
          "path": "Alert.subject",
          "definition": {
            "short": "Who is alert about?",
            "formal": "The person who this alert concerns.",
            "min": 1,
            "max": "1",
            "type": [
              {
                "code": "ResourceReference",
                "profile": "http://hl7.org/fhir/profiles/Patient"
              }
            ],
            "isModifier": false,
            "mapping": [
              {
                "identity": "rim",
                "map": ".participation[typeCode=SBJ].role[classCode=PAT]"
              }
            ]
          }
        },
        {
          "path": "Alert.author",
          "definition": {
            "short": "Alert creator",
            "formal": "The person or device that created the alert.",
            "min": 0,
            "max": "1",
            "type": [
              {
                "code": "ResourceReference",
                "profile": "http://hl7.org/fhir/profiles/Practitioner"
              },
              {
                "code": "ResourceReference",
                "profile": "http://hl7.org/fhir/profiles/Patient"
              },
              {
                "code": "ResourceReference",
                "profile": "http://hl7.org/fhir/profiles/Device"
              }
            ],
            "isModifier": false,
            "mapping": [
              {
                "identity": "rim",
                "map": ".participation[typeCode=AUT].role"
              }
            ]
          }
        },
        {
          "path": "Alert.note",
          "definition": {
            "short": "Text of alert",
            "formal": "The textual component of the alert to display to the user.",
            "min": 1,
            "max": "1",
            "type": [
              {
                "code": "string"
              }
            ],
            "isModifier": false,
            "mapping": [
              {
                "identity": "rim",
                "map": ".value"
              }
            ]
          }
        }
      ],
      "searchParam": [
        {
          "name": "_id",
          "type": "token",
          "documentation": "The logical resource id associated with the resource (must be supported by all servers)"
        },
        {
          "name": "_language",
          "type": "token",
          "documentation": "The language of the resource"
        },
        {
          "name": "subject",
          "type": "reference",
          "documentation": "The identity of a subject to list alerts for",
          "xpath": "f:Alert/f:subject"
        }
      ]
    }
  ]
}