RIVO-Noord Zorgviewer Implementation Guide
1.21.0 - CI build

RIVO-Noord Zorgviewer Implementation Guide, published by RIVO-NN HL7NL. This guide is not an authorized publication; it is the continuous build for version 1.21.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/RIVO-Noord/zorgviewer-ig/ and changes regularly. See the Directory of published versions

## Resource Profile: Alert - Detailed Descriptions

Active as of 2025-10-28

Definitions for the Flag resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. Flag
Definition | Prospective warnings of potential issues when providing care to the patient. This is the base resource type for everything.
Short | AlertBase Resource
Control | 0..*
Alternate Names | Barriers to Care, Alert, Warning
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (`contained.text.empty()`) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (`contained.where(('#'+id in %resource.descendants().reference).not()).empty()`)
2. Flag.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
Control | 0..1
Type | uri
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
4. Flag.extension:ConcernReference
Slice Name | ConcernReference
Definition | Points to the Observation, AllergyIntolerance or other record that provides additional supporting information about this flag.
Short | Resource with details for flag
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Flag details) (Extension Type: Reference(Resource))
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
6. Flag.extension:ConcernReference.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `http://hl7.org/fhir/StructureDefinition/flag-detail`
8. Flag.extension:ConcernReference.valueReference:valueReference
Slice Name | valueReference
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Short | Value of extension
Comments | Within the context of zib-Alert the concern reference is only supposed to refer to zib-Problem. The reference is unconstrained to allow other use cases.
Control | 0..1
Type | Reference(Resource), date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
10. Flag.modifierExtension
Definition | 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 set of 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.
Short | Extensions that cannot be ignored
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 level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Alternate Names | extensions, user content
12. Flag.status
Definition | Supports basic workflow.
Short | active | inactive | entered-in-error
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Control | 1..1
Binding | The codes SHALL be taken from FlagStatus http://hl7.org/fhir/ValueSet/flag-status|3.0.2 (required to `http://hl7.org/fhir/ValueSet/flag-status` ) 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.
Type | code
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
14. Flag.category
Definition | Indicates the type of alert, meaning a rough description of the cause or origin of the warning. 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.
Short | AlertTypeClinical, administrative, etc.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from For example codes, see AlertTypeCodelijst http://hl7.org/fhir/ValueSet/flag-category|3.0.2 (extensible to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.1--20171231000000` ) Indicates the type of alert, meaning a rough description of the cause or origin of the warning. A general category for flags for filtering/display purposes.
Type | CodeableConcept
Summary | true
Alternate Names | AlertType
Example | Example of AlertType: { "coding" : [{ "system" : "http://loinc.org", "code" : "75323-6", "display" : "condition", "userSelected" : false }] }
16. Flag.category.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.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
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.
18. Flag.code
Definition | A warning, other than a condition or problem. For example, a patient can be given an ‘Aggressive patient' alert. The warning can be entered in code (there are codes for frequently used alerts), but seeing the dynamic nature of the warnings cf. SARS and Ebola, these alerts will often be entered as free text. The coded value or textual component of the flag to display to the user.
Short | AlertNameCoded or textual message to display to user
Comments | According to HCIM Alert this element does not need to be filled if a reference to HCIM Problem exists. In that case, instead of leaving this element empty, the NullFlavor with `.coding.code` equal to 'OTH' SHOULD be used. If non coded, use CodeableConcept.text. This element should always be included in the narrative.
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from For example codes, see AlertNaamCodelijst http://hl7.org/fhir/ValueSet/flag-code|1.0.0 (extensible to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.2--20171231000000` ) Detail codes identifying specific flagged issues.
Type | CodeableConcept
Summary | true
Alternate Names | AlertNaam
Example | Example of AlertName: { "coding" : [{ "system" : "http://snomed.info/sct", "code" : "432415000", "display" : "Methicillin resistant staphylococcus aureus carrier" }] }
20. 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.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
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.
22. Flag.subject
Definition | The patient, location, group , organization , or practitioner, etc. this is about record this flag is associated with.
Short | Who/What is flag about?
Control | 1..1
Type | Reference(nl-core-patient, nl-core-location, Group, nl-core-organization, nl-core-practitioner, PlanDefinition, HCIM PharmaceuticalProduct, HCIM Procedure, Patient, Location, Organization, Practitioner, Medication, Procedure)
Summary | true
24. Flag.subject.extension:practitionerRole
Slice Name | practitionerRole
Definition | Optional Extension Element - found in all resources.
Short | Optional Extensions Element
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 level of simplicity for everyone.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(PractitionerRole Reference) (Extension Type: Reference)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
26. 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.
Short | Time period when flag is active
Control | 0..1
Type | Period
Summary | true
28. Flag.period.start
Definition | The date and time at which the described condition was entered as a warning. This can be an exact date and time, or a rough indication of the date (such as only the year, or the month and the year). The start of the period. The boundary is inclusive.
Short | StartDateTimeStarting time with inclusive boundary
Comments | If the low element is missing, the meaning is that the low boundary is not known.
Control | 0..1 This element is affected by the following invariants: per-1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Alternate Names | BeginDatumTijd
Example | Example of StartDateTime: 2017-02-07

Guidance on how to interpret the contents of this table can be foundhere

0. Flag
2. Flag.extension:ConcernReference
Slice Name | ConcernReference
Control | 0.. This element is affected by the following invariants: ele-1
Type | Extension(Flag details) (Extension Type: Reference(Resource))
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
4. Flag.category
6. Flag.category.text
Must Support | true
8. Flag.code
Added: 10. Flag.code.text
Must Support | true
12. Flag.period
14. Flag.period.start
Must Support | true

Guidance on how to interpret the contents of this table can be foundhere

0. Flag
Definition | Prospective warnings of potential issues when providing care to the patient.
Short | Alert
Control | 0..*
Alternate Names | Barriers to Care, Alert, Warning
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (`contained.text.empty()`) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (`contained.where(('#'+id in %resource.descendants().reference).not()).empty()`)
2. Flag.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical id of this artifact
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Control | 0..1
Type | id
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
4. Flag.meta
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Short | Metadata about the resource
Control | 0..1
Type | Meta
Summary | true
6. Flag.implicitRules
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Short | A set of rules under which this content was created
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
Control | 0..1
Type | uri
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
8. Flag.language
Definition | The base language in which the resource is written.
Short | Language of the resource content
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
All Languages | Max Binding
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
10. Flag.text
Definition | 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.
Short | Text summary of the resource, for human interpretation
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
Control | 0..1 This element is affected by the following invariants: dom-1
Type | Narrative
Alternate Names | narrative, html, xhtml, display
12. Flag.contained
Definition | 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.
Short | Contained, inline Resources
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.
Control | 0..*
Type | Resource
Alternate Names | inline resources, anonymous resources, contained resources
14. Flag.extension
Definition | Changed: 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 set of 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.
Short | Changed:Additional Content defined by implementations
Comments | Added: 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 level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Flag.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
16. Flag.extension:ConcernReference
Slice Name | ConcernReference
Definition | Points to the Observation, AllergyIntolerance or other record that provides additional supporting information about this flag.
Short | Resource with details for flag
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(Flag details) (Extension Type: Reference(Resource))
Must Support | true
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
18. Flag.extension:ConcernReference.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
20. Flag.extension:ConcernReference.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of 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.
Short | Additional Content defined by implementations
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 level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Flag.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
22. Flag.extension:ConcernReference.url
Definition | Source of the definition for the extension code - a logical name or a URL.
Short | identifies the meaning of the extension
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control | 1..1
Type | uri
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `http://hl7.org/fhir/StructureDefinition/flag-detail`
24. Flag.extension:ConcernReference.valueReference:valueReference
Slice Name | valueReference
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
Short | Value of extension
Comments | Within the context of zib-Alert the concern reference is only supposed to refer to zib-Problem. The reference is unconstrained to allow other use cases.
Control | 0..1
Type | Reference(Resource)
26. Flag.modifierExtension
Definition | 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 set of 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.
Short | Extensions that cannot be ignored
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 level of simplicity for everyone.
Control | 0..*
Type | Extension
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Alternate Names | extensions, user content
28. Flag.identifier
Definition | Identifier assigned to the flag for external use (outside the FHIR environment).
Short | Business identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Summary | true
30. Flag.status
Definition | Supports basic workflow.
Short | active | inactive | entered-in-error
Comments | This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Control | 1..1
Binding | The codes SHALL be taken from FlagStatus (required to `http://hl7.org/fhir/ValueSet/flag-status` ) 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.
Type | code
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
32. Flag.category
Definition | Indicates the type of alert, meaning a rough description of the cause or origin of the warning.
Short | AlertType
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from AlertTypeCodelijst (extensible to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.1--20171231000000` ) Indicates the type of alert, meaning a rough description of the cause or origin of the warning.
Type | CodeableConcept
Summary | true
Alternate Names | AlertType
Example | Example of AlertType: { "coding" : [{ "system" : "http://loinc.org", "code" : "75323-6", "display" : "condition", "userSelected" : false }] }
34. Flag.category.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
36. Flag.category.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of 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.
Short | Additional Content defined by implementations
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 level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Flag.category.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
38. Flag.category.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
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 labeled as UserSelected = true.
Control | 0..*
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
40. Flag.category.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.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
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.
42. Flag.code
Definition | A warning, other than a condition or problem. For example, a patient can be given an ‘Aggressive patient' alert. The warning can be entered in code (there are codes for frequently used alerts), but seeing the dynamic nature of the warnings cf. SARS and Ebola, these alerts will often be entered as free text.
Short | AlertName
Comments | According to HCIM Alert this element does not need to be filled if a reference to HCIM Problem exists. In that case, instead of leaving this element empty, the NullFlavor with `.coding.code` equal to 'OTH' SHOULD be used.
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from AlertNaamCodelijst (extensible to `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.2--20171231000000` ) Detail codes identifying specific flagged issues.
Type | CodeableConcept
Summary | true
Alternate Names | AlertNaam
Example | Example of AlertName: { "coding" : [{ "system" : "http://snomed.info/sct", "code" : "432415000", "display" : "Methicillin resistant staphylococcus aureus carrier" }] }
44. Flag.code.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
46. Flag.code.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of 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.
Short | Additional Content defined by implementations
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 level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Flag.code.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
48. Flag.code.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
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 labeled as UserSelected = true.
Control | 0..*
Type | Coding
Summary | true
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.
50. 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.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
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.
52. Flag.subject
Definition | The patient, location, group , organization , or practitioner, etc. this is about record this flag is associated with.
Short | Who/What is flag about?
Control | 1..1
Type | Reference(nl-core-patient, nl-core-location, Group, nl-core-organization, nl-core-practitioner, PlanDefinition, HCIM PharmaceuticalProduct, HCIM Procedure)
Summary | true
54. Flag.subject.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
56. Flag.subject.extension
Definition | Changed: May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of 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.
Short | Changed:Additional Content defined by implementations
Comments | Added: 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 level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Flag.subject.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
58. Flag.subject.extension:practitionerRole
Slice Name | practitionerRole
Definition | Optional Extension Element - found in all resources.
Short | Optional Extensions Element
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 level of simplicity for everyone.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(PractitionerRole Reference) (Extension Type: Reference)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
60. Flag.subject.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.
Short | Literal reference, Relative, internal or absolute URL
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.
Control | 0..1 This element is affected by the following invariants: ref-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
62. Flag.subject.identifier
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Short | Logical reference, when literal reference is not known
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Summary | true
64. Flag.subject.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Short | Text alternative for the resource
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.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
66. 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.
Short | Time period when flag is active
Control | 0..1
Type | Period
Summary | true
68. Flag.period.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
70. Flag.period.extension
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of 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.
Short | Additional Content defined by implementations
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 level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Flag.period.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
72. Flag.period.start
Definition | The date and time at which the described condition was entered as a warning. This can be an exact date and time, or a rough indication of the date (such as only the year, or the month and the year).
Short | StartDateTime
Comments | If the low element is missing, the meaning is that the low boundary is not known.
Control | 0..1 This element is affected by the following invariants: per-1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
Alternate Names | BeginDatumTijd
Example | Example of StartDateTime: 2017-02-07
74. 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.
Short | End time with inclusive boundary, if not ongoing
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.
Control | 0..1 This element is affected by the following invariants: per-1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Meaning if Missing | If the end of the period is missing, it means that the period is ongoing
76. Flag.encounter
Definition | This alert is only relevant during the encounter.
Short | Alert relevant during encounter
Comments | If both Flag.encounter and Flag.period are valued, then Flag.period.start shall not be before Encounter.period.start and Flag.period.end shall not be after Encounter.period.end.
Control | 0..1
Type | Reference(HCIM Encounter)
Summary | true
78. Flag.author
Definition | The person, organization or device that created the flag.
Short | Flag creator
Control | 0..1
Type | Reference(HCIM MedicalDevice Product, nl-core-patient, nl-core-practitioner, nl-core-organization)
Summary | true
80. Flag.author.id
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short | xml:id (or equivalent in JSON)
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
82. Flag.author.extension
Definition | Changed: May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of 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.
Short | Changed:Additional Content defined by implementations
Comments | Added: 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 level of simplicity for everyone.
Control | 0..*
Type | Extension
Alternate Names | extensions, user content
Slicing | This element introduces a set of slices on `Flag.author.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
84. Flag.author.extension:practitionerRole
Slice Name | practitionerRole
Definition | Optional Extension Element - found in all resources.
Short | Optional Extensions Element
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 level of simplicity for everyone.
Control | 0..1 This element is affected by the following invariants: ele-1
Type | Extension(PractitionerRole Reference) (Extension Type: Reference)
Alternate Names | extensions, user content
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() | (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
86. Flag.author.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.
Short | Literal reference, Relative, internal or absolute URL
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.
Control | 0..1 This element is affected by the following invariants: ref-1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
88. Flag.author.identifier
Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Short | Logical reference, when literal reference is not known
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier
Summary | true
90. Flag.author.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Short | Text alternative for the resource
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.
Control | 0..1
Type | string
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true