HL7 Czech Hospital Discharge Report Implementation Guide
0.1.0 - ci-build

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

## Resource Profile: Flag Obligations (HDR CZ)

Official URL: https://hl7.cz/fhir/hdr/StructureDefinition/cz-flag-obl-hdr | Version: 0.1.0
Standards status: Informative | Maturity Level: 0 | Computable Name: CZ_FlagObligationsHdr

This profile defines the obligations for the CZ_FlagHdr profile used in the HDR CZ 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.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Flag |  | 0..* | CZ_FlagHdr | Key information to flag to healthcare providers
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
text | O | 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
Obligations | Actor
SHOULD:able-to-populate | Creator_L2
SHOULD:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
Slices for extension |  |  |  | Content/Rules for all slices
extension:flagDetailExt |  | 0..* | Reference(Resource) | Resource with details for flag URL: http://hl7.org/fhir/StructureDefinition/flag-detail
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.
Obligations | Actor
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHALL:display | Consumer_L3
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!Σ | 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.
code | O Σ | 1..1 | CodeableConcept | Coded or textual message to display to user. Binding: FlagCode (example): Detail codes identifying specific flagged issues.
Obligations | Actor
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHALL:display | Consumer_L3
text | O Σ | 0..1 | string | Plain text representation of the concept
Obligations | Actor
SHOULD:able-to-populate | Creator_L2
SHOULD:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
subject | Σ | 1..1 | Reference(Patient (CZ core)) | Who/What is flag about?
period | O Σ | 0..1 | Period | Time period when flag is active
Obligations | Actor
SHOULD:able-to-populate | Creator_L2
SHOULD:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
author | O Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole) | Flag creator
Obligations | Actor
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHALL:display | Consumer_L3
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 CZ_FlagHdr

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Flag |  | 0..* | CZ_FlagHdr | Key information to flag to healthcare providers
text | O | 0..1 | Narrative | Text summary of the resource, for human interpretation
Obligations | Actor
SHOULD:able-to-populate | Creator_L2
SHOULD:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
Slices for extension |  |  |  | Content/Rules for all slices
extension:flagPriorityExt | O | 0..1 | FlagPriority(5.2.0) | An alarm code
Obligations | Actor
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHALL:display | Consumer_L3
code | O | 1..1 | CodeableConcept | Coded or textual message to display to user.
Obligations | Actor
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHALL:display | Consumer_L3
text | O | 0..1 | string | Plain text representation of the concept
Obligations | Actor
SHOULD:able-to-populate | Creator_L2
SHOULD:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
period | O | 0..1 | Period | Time period when flag is active
Obligations | Actor
SHOULD:able-to-populate | Creator_L2
SHOULD:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
author | O | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole) | Flag creator
Obligations | Actor
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHALL:display | Consumer_L3
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Flag |  | 0..* | CZ_FlagHdr | 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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text | O | 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
Obligations | Actor
SHOULD:able-to-populate | Creator_L2
SHOULD:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:flagDetailExt |  | 0..* | Reference(Resource) | Resource with details for flag URL: http://hl7.org/fhir/StructureDefinition/flag-detail
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.
Obligations | Actor
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHALL:display | Consumer_L3
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Business identifier
status | ?!Σ | 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.
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.
Obligations | Actor
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHALL:display | Consumer_L3
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
text | O Σ | 0..1 | string | Plain text representation of the concept
Obligations | Actor
SHOULD:able-to-populate | Creator_L2
SHOULD:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
subject | Σ | 1..1 | Reference(Patient (CZ core)) | Who/What is flag about?
period | O Σ | 0..1 | Period | Time period when flag is active
Obligations | Actor
SHOULD:able-to-populate | Creator_L2
SHOULD:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
encounter | Σ | 0..1 | Reference(Encounter) | Alert relevant during encounter
author | O Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole) | Flag creator
Obligations | Actor
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHALL:display | Consumer_L3
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 CZ_FlagHdr

Summary

Maturity: 0

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Flag |  | 0..* | CZ_FlagHdr | Key information to flag to healthcare providers
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
text | O | 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
Obligations | Actor
SHOULD:able-to-populate | Creator_L2
SHOULD:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
Slices for extension |  |  |  | Content/Rules for all slices
extension:flagDetailExt |  | 0..* | Reference(Resource) | Resource with details for flag URL: http://hl7.org/fhir/StructureDefinition/flag-detail
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.
Obligations | Actor
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHALL:display | Consumer_L3
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!Σ | 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.
code | O Σ | 1..1 | CodeableConcept | Coded or textual message to display to user. Binding: FlagCode (example): Detail codes identifying specific flagged issues.
Obligations | Actor
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHALL:display | Consumer_L3
text | O Σ | 0..1 | string | Plain text representation of the concept
Obligations | Actor
SHOULD:able-to-populate | Creator_L2
SHOULD:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
subject | Σ | 1..1 | Reference(Patient (CZ core)) | Who/What is flag about?
period | O Σ | 0..1 | Period | Time period when flag is active
Obligations | Actor
SHOULD:able-to-populate | Creator_L2
SHOULD:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
author | O Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole) | Flag creator
Obligations | Actor
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHALL:display | Consumer_L3
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 CZ_FlagHdr

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Flag |  | 0..* | CZ_FlagHdr | Key information to flag to healthcare providers
text | O | 0..1 | Narrative | Text summary of the resource, for human interpretation
Obligations | Actor
SHOULD:able-to-populate | Creator_L2
SHOULD:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
Slices for extension |  |  |  | Content/Rules for all slices
extension:flagPriorityExt | O | 0..1 | FlagPriority(5.2.0) | An alarm code
Obligations | Actor
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHALL:display | Consumer_L3
code | O | 1..1 | CodeableConcept | Coded or textual message to display to user.
Obligations | Actor
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHALL:display | Consumer_L3
text | O | 0..1 | string | Plain text representation of the concept
Obligations | Actor
SHOULD:able-to-populate | Creator_L2
SHOULD:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
period | O | 0..1 | Period | Time period when flag is active
Obligations | Actor
SHOULD:able-to-populate | Creator_L2
SHOULD:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
author | O | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole) | Flag creator
Obligations | Actor
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHALL:display | Consumer_L3
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Flag |  | 0..* | CZ_FlagHdr | 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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text | O | 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
Obligations | Actor
SHOULD:able-to-populate | Creator_L2
SHOULD:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:flagDetailExt |  | 0..* | Reference(Resource) | Resource with details for flag URL: http://hl7.org/fhir/StructureDefinition/flag-detail
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.
Obligations | Actor
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHALL:display | Consumer_L3
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 0..* | Identifier | Business identifier
status | ?!Σ | 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.
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.
Obligations | Actor
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHALL:display | Consumer_L3
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 0..* | Coding | Code defined by a terminology system
text | O Σ | 0..1 | string | Plain text representation of the concept
Obligations | Actor
SHOULD:able-to-populate | Creator_L2
SHOULD:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
subject | Σ | 1..1 | Reference(Patient (CZ core)) | Who/What is flag about?
period | O Σ | 0..1 | Period | Time period when flag is active
Obligations | Actor
SHOULD:able-to-populate | Creator_L2
SHOULD:display | Consumer_L2
SHALL:able-to-populate | Creator_L3
SHALL:display | Consumer_L3
encounter | Σ | 0..1 | Reference(Encounter) | Alert relevant during encounter
author | O Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole) | Flag creator
Obligations | Actor
SHOULD:populate-if-known | Creator_L2
SHOULD:display | Consumer_L2
SHALL:populate-if-known | Creator_L3
SHALL:display | Consumer_L3
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 CZ_FlagHdr

Summary

Maturity: 0

Other representations of profile: CSV, Excel, Schematron