Alert - RIVO-Noord Zorgviewer Implementation Guide v1.11.0

RIVO-Noord Zorgviewer Implementation Guide
1.11.0 - sprint49 Netherlands flag

This page is part of the RIVO-Noord Zorgviewer Implementation Guide (v1.11.0: Release) based on FHIR (HL7® FHIR® Standard) R3. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: Alert

Official URL: http://fhir.hl7.nl/zorgviewer/StructureDefinition/Flag				Version: 1.11.0
Active as of 2025-01-20				Computable Name: Alert

Alert (Flag)

Dit Profiel is het resultaat van de vergelijking tussen de zib2017 FHIR Profiel en de implementaties in Epic, Chipsoft, Topicus en Nexus. De elementen die in ieder geval in alle output beschikbaar zullen zijn. Voornamelijk bedoeld voor houvast van een client en voor validatie van output.

Zorginformatiebouwsteen

ZIB Alert

View Definition

ViewDefinition voor Alerts

Kolom label FHIR Path FHIR Type Zib element Toelichting of regels

Bron .meta.extension("http://hl7.org/fhir/4.0/StructureDefinition/extension-Meta.source").valueUri string nvt Lookup adhv uri (AGB-Z of OID) <adressering-base>/Organization?identifier=<.meta.tag.code> en gebruik dan Organization.name

Datum .period.start dateTime BeginDatumTijd

Voor .code.text of .extension('http://hl7.org/fhir/StructureDefinition/flag-detail').valueReference.reference.resolve().code.text string AlertNaam of geassosieerde Conditie::Probleem De resolve levert de bijbehorende Condition

Categorie .category.text string AlertType

Status .status code nvt Mapping: ‘active’ naar ‘actueel’; ‘in-active’ naar ‘niet actueel’ Uitgefilterd: ‘entered-in-error’ wordt niet getoond in de Zorgviewer, omdat het om foutief ingevoerde data gaat.

Kolom label	FHIR Path	FHIR Type	Zib element	Toelichting of regels
Bron	`.meta.extension("http://hl7.org/fhir/4.0/StructureDefinition/extension-Meta.source").valueUri`	`string`	nvt	Lookup adhv uri (AGB-Z of OID) `<adressering-base>/Organization?identifier=<.meta.tag.code>` en gebruik dan `Organization.name`
Datum	`.period.start`	`dateTime`	BeginDatumTijd
Voor	`.code.text of .extension('http://hl7.org/fhir/StructureDefinition/flag-detail').valueReference.reference.resolve().code.text`	`string`	AlertNaam of geassosieerde Conditie::Probleem	De resolve levert de bijbehorende Condition
Categorie	`.category.text`	`string`	AlertType
Status	`.status`	`code`	nvt	Mapping: ‘active’ naar ‘actueel’; ‘in-active’ naar ‘niet actueel’ Uitgefilterd: ‘entered-in-error’ wordt niet getoond in de Zorgviewer, omdat het om foutief ingevoerde data gaat.

Examples

Name

Description

Chipsoft Alert Example

Dit is een Alert voorbeeld uit Chipsoft.

Epic Alert Example

Dit is een Alert voorbeeld uit Epic.

Nexus Alert Example

Dit is een Alert voorbeeld uit Nexus.

Request

Opvragen (search) alerts

GET <ontsluiten-bronsysteem-base>/Flag?patient=<fhir_patient_id>

Bronsysteem herkennen

De Zorgviewer-backend of Ontsluiten bronsysteem MOET na bevragen van het bronsysteem aan elk resultaat resource een meta-tag toevoegen met de AGB, OID of URA identifier van de zorgaanbieder (zie Organization voor voorbeelden). Dit wordt vervolgens gebruikt in de "Bron" kolom in de Zorgviewer-frontend. N.B. We gebruiken hier een pre-adopt van de FHIR R4 Meta.source.

Toevoegen aan elke response, dus per resource (bij een read) of per Bundle (bij een search):

"meta": {
    "extension": [ {
        "url": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Meta.source",
        "valueUri": "urn:oid:2.16.840.1.113883.2.4.3.8"
    } ]
}

Alternatief: Elke entry van een search response Bundle bevat een referentie naar de bijbehorende Patient (<resource>.subject|patient). Elke patient heeft een Patient.managingOrganization en in de gerefereerde Organization.identifier staat vervolgens o.a. de OID van het bronsysyeem. Of je gebruikt de identifiers om een volledige Organization op te zoeken in het adresboek en zie inhoud hier.

Usage:

This Resource Profile is not used by any profiles in this Implementation Guide

Changes since version 1.10.0:

The data elements list has changed

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

Name	Flags	Card.	Type	Description & Constraints
Flag		0..*	Zib Alert	Alert dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
ConcernReference	S	0..1	(Complex)	Resource with details for flag URL: http://hl7.org/fhir/StructureDefinition/flag-detail ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/flag-detail"
Slices for valueReference				Content/Rules for all slices
valueReference:valueReference		0..1	Reference(Resource)	Value of extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	active \| inactive \| entered-in-error Binding: FlagStatus (required): 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.
category	Σ	0..1	CodeableConcept	AlertType Binding: AlertTypeCodelijst (extensible): Indicates the type of alert, meaning a rough description of the cause or origin of the warning. Example Example of AlertType: {"coding":[{"system":"http://loinc.org","code":"75323-6","display":"condition","userSelected":false}]}
text	SΣ	0..1	string	Plain text representation of the concept
code	Σ	1..1	CodeableConcept	AlertName Binding: AlertNaamCodelijst (extensible) Example Example of AlertName: {"coding":[{"system":"http://snomed.info/sct","code":"432415000","display":"Methicillin resistant staphylococcus aureus carrier"}]}
text	SΣ	0..1	string	Plain text representation of the concept
subject	Σ	1..1	Reference(nl-core-patient \| nl-core-location \| Group \| nl-core-organization \| nl-core-practitioner \| PlanDefinition \| HCIM PharmaceuticalProduct \| HCIM Procedure)	Who/What is flag about?
Slices for extension				Content/Rules for all slices
practitionerRole		0..1	Reference(nl-core-practitionerrole)	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
period	Σ	0..1	Period	Time period when flag is active
start	SΣC	0..1	dateTime	StartDateTime Example Example of StartDateTime: 2017-02-07
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Flag.status	required	FlagStatus `http://hl7.org/fhir/ValueSet/flag-status` from the FHIR Standard
Flag.category	extensible	AlertTypeCodelijst `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.1--20171231000000`
Flag.code	extensible	AlertNaamCodelijst `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.2--20171231000000`

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	Flag	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	Flag	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Flag	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()
dom-4	error	Flag	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()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Zib Alert

Name	Flags	Card.	Type	Description & Constraints
Flag		0..*	Zib Alert	Alert
Slices for extension				Content/Rules for all slices
ConcernReference	S	0..1	Reference(Resource)	Resource with details for flag URL: http://hl7.org/fhir/StructureDefinition/flag-detail
category
text	S	0..1	string	Plain text representation of the concept
code
text	S	0..1	string	Plain text representation of the concept
period
start	S	0..1	dateTime	StartDateTime
Documentation for this format

Description & Constraints

Flag

0..*

Zib Alert

Alert

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet URI

Flag.language

extensible

Common Languages

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Additional Bindings

Purpose

All Languages

Max Binding

Flag.status

required

FlagStatus

http://hl7.org/fhir/ValueSet/flag-status

from the FHIR Standard

Flag.category

extensible

AlertTypeCodelijst

http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.1--20171231000000

Flag.code

extensible

AlertNaamCodelijst

http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.2--20171231000000

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	Flag	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	Flag	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Flag	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()
dom-4	error	Flag	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()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Flag		0..*	Zib Alert	Alert dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
ConcernReference	S	0..1	(Complex)	Resource with details for flag URL: http://hl7.org/fhir/StructureDefinition/flag-detail ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/flag-detail"
Slices for valueReference				Content/Rules for all slices
valueReference:valueReference		0..1	Reference(Resource)	Value of extension
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	active \| inactive \| entered-in-error Binding: FlagStatus (required): 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.
category	Σ	0..1	CodeableConcept	AlertType Binding: AlertTypeCodelijst (extensible): Indicates the type of alert, meaning a rough description of the cause or origin of the warning. Example Example of AlertType: {"coding":[{"system":"http://loinc.org","code":"75323-6","display":"condition","userSelected":false}]}
text	SΣ	0..1	string	Plain text representation of the concept
code	Σ	1..1	CodeableConcept	AlertName Binding: AlertNaamCodelijst (extensible) Example Example of AlertName: {"coding":[{"system":"http://snomed.info/sct","code":"432415000","display":"Methicillin resistant staphylococcus aureus carrier"}]}
text	SΣ	0..1	string	Plain text representation of the concept
subject	Σ	1..1	Reference(nl-core-patient \| nl-core-location \| Group \| nl-core-organization \| nl-core-practitioner \| PlanDefinition \| HCIM PharmaceuticalProduct \| HCIM Procedure)	Who/What is flag about?
Slices for extension				Content/Rules for all slices
practitionerRole		0..1	Reference(nl-core-practitionerrole)	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
period	Σ	0..1	Period	Time period when flag is active
start	SΣC	0..1	dateTime	StartDateTime Example Example of StartDateTime: 2017-02-07
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Flag.status	required	FlagStatus `http://hl7.org/fhir/ValueSet/flag-status` from the FHIR Standard
Flag.category	extensible	AlertTypeCodelijst `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.1--20171231000000`
Flag.code	extensible	AlertNaamCodelijst `http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.2--20171231000000`

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	Flag	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	Flag	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Flag	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()
dom-4	error	Flag	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()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from Zib Alert

Name	Flags	Card.	Type	Description & Constraints
Flag		0..*	Zib Alert	Alert
Slices for extension				Content/Rules for all slices
ConcernReference	S	0..1	Reference(Resource)	Resource with details for flag URL: http://hl7.org/fhir/StructureDefinition/flag-detail
category
text	S	0..1	string	Plain text representation of the concept
code
text	S	0..1	string	Plain text representation of the concept
period
start	S	0..1	dateTime	StartDateTime
Documentation for this format

Snapshot View

Description & Constraints

Flag

0..*

Zib Alert

Alert

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet URI

Flag.language

extensible

Common Languages

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Additional Bindings

Purpose

All Languages

Max Binding

Flag.status

required

FlagStatus

http://hl7.org/fhir/ValueSet/flag-status

from the FHIR Standard

Flag.category

extensible

AlertTypeCodelijst

http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.1--20171231000000

Flag.code

extensible

AlertNaamCodelijst

http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.2--20171231000000

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	Flag	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-2	error	Flag	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Flag	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()
dom-4	error	Flag	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()
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Zib Alert

Summary

Must-Support: 4 elements

Extensions

This structure refers to these extensions:

http://hl7.org/fhir/StructureDefinition/flag-detail

Other representations of profile: CSV, Excel, Schematron

IG © 2023+ RIVO-NN HL7NL. Package hl7.fhir.nl.zorgviewer#1.11.0 based on FHIR 3.0.2. Generated 2025-01-20
Links: Table of Contents | QA Report