RIVO-Noord Zorgviewer Implementation Guide
1.5.0 - CI build Netherlands flag

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

Official URL: http://hl7.nl/fhir/zorgviewer/StructureDefinition/Flag Version: 1.5.0
Active as of 2024-09-16 Computable Name: Alert

Alert

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

User-Interface guidance

Een schets van het scherm met labels en sortering informatie

Kolom definities:

Kolom label FHIR Path FHIR Type Zib element Toelichting of regels
Bron .meta.extension[system="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 ​
Categorie Flag.category.text of Condition.category[0].text string​ AlertNaam of Conditie::Probleem Indien Condition.category[0].text null is wordt de Flag.category.text getoond
Voor Flag.code.text of Condition.code.text string​ AlertType Indien Condition.code.text null is wordt de Flag.code.text getoond

Request

  1. Opvragen (search) definities

    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

Formal Views of Profile Content

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

This structure is derived from Zib Alert

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..* Zib Alert Alert
... 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..* Zib Alert Alert
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... ConcernReference 0..1 (Complex) Condition
URL: http://hl7.org/fhir/StructureDefinition/flag-detail
..... 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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Flag.statusrequiredFlagStatus
http://hl7.org/fhir/ValueSet/flag-status
from the FHIR Standard
Flag.categoryextensibleAlertTypeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.1--20171231000000
Flag.codeextensibleAlertNaamCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.2--20171231000000

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorFlagIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorFlagIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFlagIf 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-4errorFlagIf 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..* Zib Alert Alert
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... ConcernReference 0..1 (Complex) Condition
URL: http://hl7.org/fhir/StructureDefinition/flag-detail
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... 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
... identifier Σ 0..* Identifier Business identifier
... 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}]}
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... 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"}]}
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... 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?
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... period Σ 0..1 Period Time period when flag is active
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC 0..1 dateTime StartDateTime
Example Example of StartDateTime: 2017-02-07
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... encounter Σ 0..1 Reference(HCIM Encounter) Alert relevant during encounter
... author Σ 0..1 Reference(HCIM MedicalDevice Product | nl-core-patient | nl-core-practitioner | nl-core-organization) Flag creator
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Flag.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Flag.statusrequiredFlagStatus
http://hl7.org/fhir/ValueSet/flag-status
from the FHIR Standard
Flag.categoryextensibleAlertTypeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.1--20171231000000
Flag.codeextensibleAlertNaamCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.2--20171231000000

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorFlagIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorFlagIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFlagIf 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-4errorFlagIf 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Zib Alert

Summary

Must-Support: 3 elements

Differential View

This structure is derived from Zib Alert

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..* Zib Alert Alert
... 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

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..* Zib Alert Alert
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... ConcernReference 0..1 (Complex) Condition
URL: http://hl7.org/fhir/StructureDefinition/flag-detail
..... 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
... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Flag.statusrequiredFlagStatus
http://hl7.org/fhir/ValueSet/flag-status
from the FHIR Standard
Flag.categoryextensibleAlertTypeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.1--20171231000000
Flag.codeextensibleAlertNaamCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.2--20171231000000

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorFlagIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorFlagIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFlagIf 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-4errorFlagIf 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Flag 0..* Zib Alert Alert
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... ConcernReference 0..1 (Complex) Condition
URL: http://hl7.org/fhir/StructureDefinition/flag-detail
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
..... 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
... identifier Σ 0..* Identifier Business identifier
... 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}]}
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... 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"}]}
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... 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?
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... period Σ 0..1 Period Time period when flag is active
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC 0..1 dateTime StartDateTime
Example Example of StartDateTime: 2017-02-07
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... encounter Σ 0..1 Reference(HCIM Encounter) Alert relevant during encounter
... author Σ 0..1 Reference(HCIM MedicalDevice Product | nl-core-patient | nl-core-practitioner | nl-core-organization) Flag creator
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... practitionerRole 0..1 Reference(nl-core-practitionerrole) Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Flag.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Flag.statusrequiredFlagStatus
http://hl7.org/fhir/ValueSet/flag-status
from the FHIR Standard
Flag.categoryextensibleAlertTypeCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.1--20171231000000
Flag.codeextensibleAlertNaamCodelijst
http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.3.2--20171231000000

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorFlagIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorFlagIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorFlagIf 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-4errorFlagIf 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Zib Alert

Summary

Must-Support: 3 elements

 

Other representations of profile: CSV, Excel, Schematron