EOLDocument

COFE-Risk-Flag-1

COFE-Risk-Flag-1

Flag
Definition

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

Control 0..*
Type Flag
Aliases Barriers to Care, Alert, Warning
Comments
Flag.identifier
Definition

Identifier assigned to the flag for external use (outside the FHIR environment).

Control 1..1
Type Identifier
Comments
Flag.identifier.value
Definition

The portion of the identifier typically displayed to the user and which is unique within the context of the system.

Control 1..1
Type String
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.

Example c70a662f-8593-40a6-ae74-7f3237de2291
Flag.category
Definition

Allows an flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.

Control 1..1
Binding

A general category for flags for filtering/display purposes.

The codes SHALL be taken from http://fhir.nhs.net/ValueSet/flag-category-1

Type CodeableConcept
Comments
Flag.category.coding
Definition

A reference to a code defined by a terminology system.

Control 1..1
Binding

A vocabulary that should be used to define the category of the flag.

The codes SHALL be taken from http://fhir.nhs.net/ValueSet/flag-category-1

Type Coding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

Flag.category.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control 1..1
Type Uri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Fixed Value http://fhir.nhs.net/ValueSet/flag-category-1
Flag.category.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control 1..1
Type Code
Requirements

Need to refer to a particular code in the system.

Comments
Flag.category.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control 1..1
Type String
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments
Flag.status
Definition

Supports basic workflow.

Control 1..1
Binding

Indicates whether this flag is active and needs to be displayed to a user, or whether it is no longer needed or entered in error.

The codes SHALL be taken from http://hl7.org/fhir/ValueSet/flag-status

Type Code
Is Modifier True
Comments
Fixed Value active
Flag.period
Definition

The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified.

Control 1..1
Type Period
Comments
Flag.period.start
Definition

The start of the period. The boundary is inclusive.

Control 1..1 ?
Type DateTime
Comments

If the low element is missing, the meaning is that the low boundary is not known.

Flag.period.end
Definition

The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Control 0..1 ?
Type DateTime
Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.

Flag.subject
Definition

The patient, location, group , organization , or practitioner this is about record this flag is associated with.

Control 1..1
Type Choice of:
Comments
Flag.encounter
Definition

This alert is only relevant during the encounter.

Control 0..1
Comments
Flag.encounter.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control 1..1 ?
Type String
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Flag.encounter.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control 0..1
Type String
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Flag.author
Definition

The person, organization or device that created the flag.

Control 0..1
Type Choice of:
Comments
Flag.code
Definition

The coded value or textual component of the flag to display to the user.

Control 1..1
Binding

SNOMED CT UK codes identifying a specific risk.

The codes SHALL be taken from http://fhir.nhs.net/ValueSet/finding-snct-1

Type CodeableConcept
Comments
Flag.code.coding
Definition

A reference to a code defined by a terminology system.

Control 0..1
Type Coding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

Flag.code.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control 1..1
Type Uri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Fixed Value http://fhir.nhs.net/ValueSet/finding-snct-1
Flag.code.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control 1..1
Binding

SNOMED CT UK code to describe risks.

The codes SHALL be taken from http://fhir.nhs.net/ValueSet/finding-snct-1

Type Code
Requirements

Need to refer to a particular code in the system.

Comments
Example 1780431016
Flag.code.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control 1..1
Type String
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments
Example Violent acts towards others
Flag.code.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control 0..1
Type String
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.