HL7 Europe Hospital Discharge Report
0.1.0-ci-build - ci-build 150

HL7 Europe Hospital Discharge Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/hdr/ and changes regularly. See the Directory of published versions

Resource Profile: Flag: obligations

Official URL: http://hl7.eu/fhir/hdr/StructureDefinition/flag-obl-eu-hdr Version: 0.1.0-ci-build
Standards status: Informative Maturity Level: 0 Computable Name: FlagEuHdrObligation

Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License

This profile defines obligations for the Flag resource to represent alerts or warnings in FHIR for the purpose of this project.

Usages:

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

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag 0..* FlagEuHdr Key information to flag to healthcare providers
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:flagDetailExt O 0..* Reference(Resource) Resource with details for flag
URL: http://hl7.org/fhir/StructureDefinition/flag-detail
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
.... extension:flagPriorityExt O 0..1 CodeableConcept An alarm code
URL: http://hl7.org/fhir/StructureDefinition/flag-priority
Binding: FlagPriorityCodes (example): A code of the alarm.
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code OΣ 1..1 CodeableConcept Coded or textual message to display to user.
Binding: FlagCode (example): Detail codes identifying specific flagged issues.
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator
... subject OΣ 1..1 Reference(Patient (EU core)) Who/What is flag about?
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Flag.status Base required FlagStatus 📍4.0.1 FHIR Std.
Flag.code Base example Flag Code 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error Flag If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Flag A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (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 FlagEuHdr

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag 0..* FlagEuHdr Key information to flag to healthcare providers
... Slices for extension Content/Rules for all slices
.... extension:flagDetailExt O 0..* FlagDetail(5.2.0) Resource with details for flag
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
.... extension:flagPriorityExt O 0..1 FlagPriority(5.2.0) An alarm code
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
... status O 1..1 code Alert status
ObligationsActor
SHALL:handle HDRConsumer
SHOULD:able-to-populate HDRCreator
... code O 1..1 CodeableConcept Coded or textual message to display to user.
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag 0..* FlagEuHdr Key information to flag to healthcare providers
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:flagDetailExt O 0..* Reference(Resource) Resource with details for flag
URL: http://hl7.org/fhir/StructureDefinition/flag-detail
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
.... extension:flagPriorityExt O 0..1 CodeableConcept An alarm code
URL: http://hl7.org/fhir/StructureDefinition/flag-priority
Binding: FlagPriorityCodes (example): A code of the alarm.
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier
... status ?!OΣ 1..1 code Alert status
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 was entered in error.
ObligationsActor
SHALL:handle HDRConsumer
SHOULD:able-to-populate HDRCreator
... category Σ 0..* CodeableConcept Clinical, administrative, etc.
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
... code OΣ 1..1 CodeableConcept Coded or textual message to display to user.
Binding: FlagCode (example): Detail codes identifying specific flagged issues.
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator
... subject OΣ 1..1 Reference(Patient (EU core)) Who/What is flag about?
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator
... period Σ 0..1 Period Time period when flag is active
... encounter Σ 0..1 Reference(Encounter) Alert relevant during encounter
... author Σ 0..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole) Flag creator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Flag.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Flag.status Base required FlagStatus 📍4.0.1 FHIR Std.
Flag.category Base example Flag Category 📍4.0.1 FHIR Std.
Flag.code Base example Flag Code 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error Flag If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Flag A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (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 FlagEuHdr

Summary

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag 0..* FlagEuHdr Key information to flag to healthcare providers
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:flagDetailExt O 0..* Reference(Resource) Resource with details for flag
URL: http://hl7.org/fhir/StructureDefinition/flag-detail
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
.... extension:flagPriorityExt O 0..1 CodeableConcept An alarm code
URL: http://hl7.org/fhir/StructureDefinition/flag-priority
Binding: FlagPriorityCodes (example): A code of the alarm.
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code OΣ 1..1 CodeableConcept Coded or textual message to display to user.
Binding: FlagCode (example): Detail codes identifying specific flagged issues.
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator
... subject OΣ 1..1 Reference(Patient (EU core)) Who/What is flag about?
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Flag.status Base required FlagStatus 📍4.0.1 FHIR Std.
Flag.code Base example Flag Code 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error Flag If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Flag A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (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 FlagEuHdr

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag 0..* FlagEuHdr Key information to flag to healthcare providers
... Slices for extension Content/Rules for all slices
.... extension:flagDetailExt O 0..* FlagDetail(5.2.0) Resource with details for flag
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
.... extension:flagPriorityExt O 0..1 FlagPriority(5.2.0) An alarm code
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
... status O 1..1 code Alert status
ObligationsActor
SHALL:handle HDRConsumer
SHOULD:able-to-populate HDRCreator
... code O 1..1 CodeableConcept Coded or textual message to display to user.
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Flag 0..* FlagEuHdr Key information to flag to healthcare providers
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:flagDetailExt O 0..* Reference(Resource) Resource with details for flag
URL: http://hl7.org/fhir/StructureDefinition/flag-detail
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
.... extension:flagPriorityExt O 0..1 CodeableConcept An alarm code
URL: http://hl7.org/fhir/StructureDefinition/flag-priority
Binding: FlagPriorityCodes (example): A code of the alarm.
ObligationsActor
SHALL:handle HDRConsumer
MAY:able-to-populate HDRCreator
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier
... status ?!OΣ 1..1 code Alert status
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 was entered in error.
ObligationsActor
SHALL:handle HDRConsumer
SHOULD:able-to-populate HDRCreator
... category Σ 0..* CodeableConcept Clinical, administrative, etc.
Binding: FlagCategory (example): A general category for flags for filtering/display purposes.
... code OΣ 1..1 CodeableConcept Coded or textual message to display to user.
Binding: FlagCode (example): Detail codes identifying specific flagged issues.
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator
... subject OΣ 1..1 Reference(Patient (EU core)) Who/What is flag about?
ObligationsActor
SHALL:handle HDRConsumer
SHALL:able-to-populate HDRCreator
... period Σ 0..1 Period Time period when flag is active
... encounter Σ 0..1 Reference(Encounter) Alert relevant during encounter
... author Σ 0..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole) Flag creator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Flag.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Flag.status Base required FlagStatus 📍4.0.1 FHIR Std.
Flag.category Base example Flag Category 📍4.0.1 FHIR Std.
Flag.code Base example Flag Code 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).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()
dom-5 error Flag If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Flag A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (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 FlagEuHdr

Summary

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron