2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

5.18 Resource Alert - Content

This resource maintained by the Patient Care Work Group

Prospective warnings of potential issues when providing care to the patient.

5.18.1 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.

5.18.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Alert DomainResourceKey information to flag to healthcare providers
... identifier 0..*IdentifierBusiness identifier
... category 0..1CodeableConceptClinical, administrative, etc.
... status M1..1codeactive | inactive | entered-in-error
AlertStatus (Required)
... subject 1..1PatientWho is alert about?
... author 0..1Practitioner | Patient | DeviceAlert creator
... note 1..1CodeableConceptPartially deaf, Requires easy open caps, No permanent address, etc.

XML Template

<Alert xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifier --></identifier>
 <category><!-- 0..1 CodeableConcept Clinical, administrative, etc. --></category>
 <status value="[code]"/><!-- 1..1 active | inactive | entered-in-error -->
 <subject><!-- 1..1 Reference(Patient) Who is alert about? --></subject>
 <author><!-- 0..1 Reference(Practitioner|Patient|Device) Alert creator --></author>
 <note><!-- 1..1 CodeableConcept 
     Partially deaf, Requires easy open caps, No permanent address, etc. --></note>
</Alert>

JSON Template

{doco
  "resourceType" : "Alert",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier
  "category" : { CodeableConcept }, // Clinical, administrative, etc.
  "status" : "<code>", // R! active | inactive | entered-in-error
  "subject" : { Reference(Patient) }, // R! Who is alert about?
  "author" : { Reference(Practitioner|Patient|Device) }, // Alert creator
  "note" : { CodeableConcept } // R! 
     Partially deaf, Requires easy open caps, No permanent address, etc.
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Alert DomainResourceKey information to flag to healthcare providers
... identifier 0..*IdentifierBusiness identifier
... category 0..1CodeableConceptClinical, administrative, etc.
... status M1..1codeactive | inactive | entered-in-error
AlertStatus (Required)
... subject 1..1PatientWho is alert about?
... author 0..1Practitioner | Patient | DeviceAlert creator
... note 1..1CodeableConceptPartially deaf, Requires easy open caps, No permanent address, etc.

XML Template

<Alert xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifier --></identifier>
 <category><!-- 0..1 CodeableConcept Clinical, administrative, etc. --></category>
 <status value="[code]"/><!-- 1..1 active | inactive | entered-in-error -->
 <subject><!-- 1..1 Reference(Patient) Who is alert about? --></subject>
 <author><!-- 0..1 Reference(Practitioner|Patient|Device) Alert creator --></author>
 <note><!-- 1..1 CodeableConcept 
     Partially deaf, Requires easy open caps, No permanent address, etc. --></note>
</Alert>

JSON Template

{doco
  "resourceType" : "Alert",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier
  "category" : { CodeableConcept }, // Clinical, administrative, etc.
  "status" : "<code>", // R! active | inactive | entered-in-error
  "subject" : { Reference(Patient) }, // R! Who is alert about?
  "author" : { Reference(Practitioner|Patient|Device) }, // Alert creator
  "note" : { CodeableConcept } // R! 
     Partially deaf, Requires easy open caps, No permanent address, etc.
}

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire

5.18.2.1 Terminology Bindings

PathDefinitionTypeReference
Alert.status Indicates whether this alert is active and needs to be displayed to a user, or whether it is no longer needed or entered in errorFixedhttp://hl7.org/fhir/alert-status

The Alert resource is sometimes known as "patient notes" and MAY be used to warn of issues such as:

  • Issues that impact on the patient's ability to receive/respond to care the care provision process itself (e.g. poor language comprehension, low compliance expected)
  • Issues that impact on the ability to provide care (e.g patient has a big dog at home)
  • Financial matters (e.g. patient is a bad debtor)

The Alert resource should not be used for Allergies / Adverse Reactions (use AllergyIntolerance, or to record Alarms raised by devices attached to the patient (DSTU - under development).

5.18.3 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPaths
patientreferenceThe identity of a subject to list alerts forAlert.subject
(Patient)
subjectreferenceThe identity of a subject to list alerts forAlert.subject
(Patient)