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

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: Allergy Intolerance Obligations (HDR CZ)

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

This profile defines the obligations for the CZ_AllergyIntoleranceHdr 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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* CZ_AllergyIntoleranceHdr Czech Allergy Intolerance
This profile also imposes the profile AllergyIntolerance (IPS) (2.0.0)
Constraints: ait-1, ait-2
... 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
ObligationsActor
SHALL:able-to-populate Creator_L2
SHALL:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
... Slices for extension Content/Rules for all slices
.... extension:abatement O 0..1 (Complex) When the allergy or intolerance resolved
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
ObligationsActor
SHOULD:able-to-populate Creator_L2
SHOULD:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
..... Slices for value[x] 1..1 Value of extension
Slice: Unordered, Open by type:$this
...... valueDateTime dateTime
...... valueAge Age
...... valuePeriod Period
...... valueRange Range
...... valueString string
...... value[x]:valueDateTime 0..1 dateTime End date
... identifier Σ 1..* Identifier External ids for this item
... clinicalStatus ?!OΣC 1..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
ObligationsActor
SHOULD:able-to-populate Creator_L2
SHOULD:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
... verificationStatus ?!OΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHALL:populate-if-known Creator_L3
SHALL:display Consumer_L3
... type OΣ 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHALL:populate-if-known Creator_L3
SHALL:display Consumer_L3
... criticality OΣ 0..1 code low | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
ObligationsActor
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 Code that identifies the allergy or intolerance
Binding: eHDSI Agent or Allergen With Exceptions (preferred)
ObligationsActor
SHOULD:able-to-populate Creator_L2
SHOULD:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
... patient Σ 1..1 Reference(Patient (CZ core)) Who the sensitivity is for
... onset[x] O 0..1 When allergy or intolerance was identified
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHALL:populate-if-known Creator_L3
SHALL:display Consumer_L3
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
... lastOccurrence O 0..1 dateTime Date(/time) of last known occurrence of a reaction
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHOULD:populate-if-known Creator_L3
SHOULD:display Consumer_L3

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📦4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📦4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base preferred eHDSI Agent or Allergen With Exceptions 📦0.3.0-ballot HL7 Czech Base and Core Implementation Guide vnull

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance 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 AllergyIntolerance 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 AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance 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_AllergyIntoleranceHdr

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* CZ_AllergyIntoleranceHdr Czech Allergy Intolerance
This profile also imposes the profile AllergyIntolerance (IPS) (2.0.0)
... text O 0..1 Narrative Text summary of the resource, for human interpretation
ObligationsActor
SHALL:able-to-populate Creator_L2
SHALL:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
... Slices for extension Content/Rules for all slices
.... extension:abatement O 0..1 Abatement When the allergy or intolerance resolved
ObligationsActor
SHOULD:able-to-populate Creator_L2
SHOULD:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
... clinicalStatus O 1..1 CodeableConcept active | inactive | resolved
ObligationsActor
SHOULD:able-to-populate Creator_L2
SHOULD:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
... type O 0..1 code allergy | intolerance - Underlying mechanism (if known)
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHALL:populate-if-known Creator_L3
SHALL:display Consumer_L3
... criticality O 0..1 code low | high | unable-to-assess
ObligationsActor
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 Code that identifies the allergy or intolerance
ObligationsActor
SHOULD:able-to-populate Creator_L2
SHOULD:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
... onset[x] O 0..1 dateTime, Age, Period, Range, string When allergy or intolerance was identified
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHALL:populate-if-known Creator_L3
SHALL:display Consumer_L3
... lastOccurrence O 0..1 dateTime Date(/time) of last known occurrence of a reaction
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHOULD:populate-if-known Creator_L3
SHOULD:display Consumer_L3
... reaction
.... manifestation O 1..* CodeableConcept Clinical symptoms/signs associated with the Event
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHALL:populate-if-known Creator_L3
SHALL:display Consumer_L3

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* CZ_AllergyIntoleranceHdr Czech Allergy Intolerance
This profile also imposes the profile AllergyIntolerance (IPS) (2.0.0)
Constraints: ait-1, ait-2
... 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 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
ObligationsActor
SHALL:able-to-populate Creator_L2
SHALL: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:abatement O 0..1 (Complex) When the allergy or intolerance resolved
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
ObligationsActor
SHOULD:able-to-populate Creator_L2
SHOULD:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
..... Slices for value[x] 1..1 Value of extension
Slice: Unordered, Open by type:$this
...... valueDateTime dateTime
...... valueAge Age
...... valuePeriod Period
...... valueRange Range
...... valueString string
...... value[x]:valueDateTime 0..1 dateTime End date
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier External ids for this item
... clinicalStatus ?!OΣC 1..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
ObligationsActor
SHOULD:able-to-populate Creator_L2
SHOULD:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
... verificationStatus ?!OΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHALL:populate-if-known Creator_L3
SHALL:display Consumer_L3
... type OΣ 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHALL:populate-if-known Creator_L3
SHALL:display Consumer_L3
... category Σ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required)
... criticality OΣ 0..1 code low | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
ObligationsActor
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 Code that identifies the allergy or intolerance
Binding: eHDSI Agent or Allergen With Exceptions (preferred)
ObligationsActor
SHOULD:able-to-populate Creator_L2
SHOULD:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
... patient Σ 1..1 Reference(Patient (CZ core)) Who the sensitivity is for
... encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... onset[x] O 0..1 When allergy or intolerance was identified
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHALL:populate-if-known Creator_L3
SHALL:display Consumer_L3
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
... recordedDate 0..1 dateTime Date first version of the resource instance was recorded
... recorder 0..1 Reference(Practitioner (CZ core) | Practitioner Role (CZ core) | Patient (CZ core) | Related Person (CZ core)) Who recorded the sensitivity
... asserter Σ 0..1 Reference(Patient (CZ core) | Related Person (CZ core) | Practitioner (CZ core) | Practitioner Role (CZ core)) Source of the information about the allergy
... lastOccurrence O 0..1 dateTime Date(/time) of last known occurrence of a reaction
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHOULD:populate-if-known Creator_L3
SHOULD:display Consumer_L3
... note 0..* Annotation Additional text not captured in other fields
... reaction 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
.... manifestation O 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHALL:populate-if-known Creator_L3
SHALL:display Consumer_L3
.... description 0..1 string Description of the event as a whole
.... onset 0..1 dateTime Date(/time) when manifestations showed
.... severity 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
.... exposureRoute 0..1 CodeableConcept How the subject was exposed to the substance
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
.... note 0..* Annotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.language Base preferred Common Languages 📍4.0.1 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📦4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📦4.0.1 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📦4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base preferred eHDSI Agent or Allergen With Exceptions 📦0.3.0-ballot HL7 Czech Base and Core Implementation Guide vnull
AllergyIntolerance.reaction.​substance Base example Substance Code 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base example SNOMED CT Route Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance 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 AllergyIntolerance 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 AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance 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_AllergyIntoleranceHdr

Summary

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* CZ_AllergyIntoleranceHdr Czech Allergy Intolerance
This profile also imposes the profile AllergyIntolerance (IPS) (2.0.0)
Constraints: ait-1, ait-2
... 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
ObligationsActor
SHALL:able-to-populate Creator_L2
SHALL:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
... Slices for extension Content/Rules for all slices
.... extension:abatement O 0..1 (Complex) When the allergy or intolerance resolved
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
ObligationsActor
SHOULD:able-to-populate Creator_L2
SHOULD:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
..... Slices for value[x] 1..1 Value of extension
Slice: Unordered, Open by type:$this
...... valueDateTime dateTime
...... valueAge Age
...... valuePeriod Period
...... valueRange Range
...... valueString string
...... value[x]:valueDateTime 0..1 dateTime End date
... identifier Σ 1..* Identifier External ids for this item
... clinicalStatus ?!OΣC 1..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
ObligationsActor
SHOULD:able-to-populate Creator_L2
SHOULD:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
... verificationStatus ?!OΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHALL:populate-if-known Creator_L3
SHALL:display Consumer_L3
... type OΣ 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHALL:populate-if-known Creator_L3
SHALL:display Consumer_L3
... criticality OΣ 0..1 code low | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
ObligationsActor
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 Code that identifies the allergy or intolerance
Binding: eHDSI Agent or Allergen With Exceptions (preferred)
ObligationsActor
SHOULD:able-to-populate Creator_L2
SHOULD:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
... patient Σ 1..1 Reference(Patient (CZ core)) Who the sensitivity is for
... onset[x] O 0..1 When allergy or intolerance was identified
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHALL:populate-if-known Creator_L3
SHALL:display Consumer_L3
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
... lastOccurrence O 0..1 dateTime Date(/time) of last known occurrence of a reaction
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHOULD:populate-if-known Creator_L3
SHOULD:display Consumer_L3

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📦4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📦4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base preferred eHDSI Agent or Allergen With Exceptions 📦0.3.0-ballot HL7 Czech Base and Core Implementation Guide vnull

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance 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 AllergyIntolerance 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 AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance 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_AllergyIntoleranceHdr

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance 0..* CZ_AllergyIntoleranceHdr Czech Allergy Intolerance
This profile also imposes the profile AllergyIntolerance (IPS) (2.0.0)
... text O 0..1 Narrative Text summary of the resource, for human interpretation
ObligationsActor
SHALL:able-to-populate Creator_L2
SHALL:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
... Slices for extension Content/Rules for all slices
.... extension:abatement O 0..1 Abatement When the allergy or intolerance resolved
ObligationsActor
SHOULD:able-to-populate Creator_L2
SHOULD:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
... clinicalStatus O 1..1 CodeableConcept active | inactive | resolved
ObligationsActor
SHOULD:able-to-populate Creator_L2
SHOULD:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
... type O 0..1 code allergy | intolerance - Underlying mechanism (if known)
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHALL:populate-if-known Creator_L3
SHALL:display Consumer_L3
... criticality O 0..1 code low | high | unable-to-assess
ObligationsActor
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 Code that identifies the allergy or intolerance
ObligationsActor
SHOULD:able-to-populate Creator_L2
SHOULD:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
... onset[x] O 0..1 dateTime, Age, Period, Range, string When allergy or intolerance was identified
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHALL:populate-if-known Creator_L3
SHALL:display Consumer_L3
... lastOccurrence O 0..1 dateTime Date(/time) of last known occurrence of a reaction
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHOULD:populate-if-known Creator_L3
SHOULD:display Consumer_L3
... reaction
.... manifestation O 1..* CodeableConcept Clinical symptoms/signs associated with the Event
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHALL:populate-if-known Creator_L3
SHALL:display Consumer_L3

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. AllergyIntolerance C 0..* CZ_AllergyIntoleranceHdr Czech Allergy Intolerance
This profile also imposes the profile AllergyIntolerance (IPS) (2.0.0)
Constraints: ait-1, ait-2
... 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 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
ObligationsActor
SHALL:able-to-populate Creator_L2
SHALL: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:abatement O 0..1 (Complex) When the allergy or intolerance resolved
URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement
ObligationsActor
SHOULD:able-to-populate Creator_L2
SHOULD:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement"
..... Slices for value[x] 1..1 Value of extension
Slice: Unordered, Open by type:$this
...... valueDateTime dateTime
...... valueAge Age
...... valuePeriod Period
...... valueRange Range
...... valueString string
...... value[x]:valueDateTime 0..1 dateTime End date
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 1..* Identifier External ids for this item
... clinicalStatus ?!OΣC 1..1 CodeableConcept active | inactive | resolved
Binding: AllergyIntoleranceClinicalStatusCodes (required)
ObligationsActor
SHOULD:able-to-populate Creator_L2
SHOULD:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
... verificationStatus ?!OΣC 0..1 CodeableConcept unconfirmed | confirmed | refuted | entered-in-error
Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHALL:populate-if-known Creator_L3
SHALL:display Consumer_L3
... type OΣ 0..1 code allergy | intolerance - Underlying mechanism (if known)
Binding: AllergyIntoleranceType (required)
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHALL:populate-if-known Creator_L3
SHALL:display Consumer_L3
... category Σ 0..* code food | medication | environment | biologic
Binding: AllergyIntoleranceCategory (required)
... criticality OΣ 0..1 code low | high | unable-to-assess
Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
ObligationsActor
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 Code that identifies the allergy or intolerance
Binding: eHDSI Agent or Allergen With Exceptions (preferred)
ObligationsActor
SHOULD:able-to-populate Creator_L2
SHOULD:display Consumer_L2
SHALL:able-to-populate Creator_L3
SHALL:display Consumer_L3
... patient Σ 1..1 Reference(Patient (CZ core)) Who the sensitivity is for
... encounter 0..1 Reference(Encounter) Encounter when the allergy or intolerance was asserted
... onset[x] O 0..1 When allergy or intolerance was identified
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHALL:populate-if-known Creator_L3
SHALL:display Consumer_L3
.... onsetDateTime dateTime
.... onsetAge Age
.... onsetPeriod Period
.... onsetRange Range
.... onsetString string
... recordedDate 0..1 dateTime Date first version of the resource instance was recorded
... recorder 0..1 Reference(Practitioner (CZ core) | Practitioner Role (CZ core) | Patient (CZ core) | Related Person (CZ core)) Who recorded the sensitivity
... asserter Σ 0..1 Reference(Patient (CZ core) | Related Person (CZ core) | Practitioner (CZ core) | Practitioner Role (CZ core)) Source of the information about the allergy
... lastOccurrence O 0..1 dateTime Date(/time) of last known occurrence of a reaction
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHOULD:populate-if-known Creator_L3
SHOULD:display Consumer_L3
... note 0..* Annotation Additional text not captured in other fields
... reaction 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... substance 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Binding: SubstanceCode (example): Codes defining the type of the substance (including pharmaceutical products).
.... manifestation O 1..* CodeableConcept Clinical symptoms/signs associated with the Event
Binding: SNOMEDCTClinicalFindings (example): Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.
ObligationsActor
SHOULD:populate-if-known Creator_L2
SHOULD:display Consumer_L2
SHALL:populate-if-known Creator_L3
SHALL:display Consumer_L3
.... description 0..1 string Description of the event as a whole
.... onset 0..1 dateTime Date(/time) when manifestations showed
.... severity 0..1 code mild | moderate | severe (of event as a whole)
Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
.... exposureRoute 0..1 CodeableConcept How the subject was exposed to the substance
Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
.... note 0..* Annotation Text about event not captured in other fields

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
AllergyIntolerance.language Base preferred Common Languages 📍4.0.1 FHIR Std.
AllergyIntolerance.clinicalStatus Base required AllergyIntolerance Clinical Status Codes 📦4.0.1 FHIR Std.
AllergyIntolerance.verificationStatus Base required AllergyIntolerance Verification Status Codes 📍4.0.1 FHIR Std.
AllergyIntolerance.type Base required AllergyIntoleranceType 📦4.0.1 FHIR Std.
AllergyIntolerance.category Base required AllergyIntoleranceCategory 📦4.0.1 FHIR Std.
AllergyIntolerance.criticality Base required AllergyIntoleranceCriticality 📍4.0.1 FHIR Std.
AllergyIntolerance.code Base preferred eHDSI Agent or Allergen With Exceptions 📦0.3.0-ballot HL7 Czech Base and Core Implementation Guide vnull
AllergyIntolerance.reaction.​substance Base example Substance Code 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​manifestation Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​severity Base required AllergyIntoleranceSeverity 📍4.0.1 FHIR Std.
AllergyIntolerance.reaction.​exposureRoute Base example SNOMED CT Route Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ait-1 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists()
ait-2 error AllergyIntolerance AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty()
dom-2 error AllergyIntolerance If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error AllergyIntolerance 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 AllergyIntolerance 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 AllergyIntolerance If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice AllergyIntolerance 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_AllergyIntoleranceHdr

Summary

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron