HL7 Czech PS Implementation Guide
0.0.1 - ci-build
CZ
HL7 Czech PS Implementation Guide
0.0.1 - ci-build
CZ
HL7 Czech PS Implementation Guide, published by HL7 Czech Republic. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-cz/ps/ and changes regularly. See the Directory of published versions
| Official URL: https://hl7.cz/fhir/ps/StructureDefinition/cz-allergyIntolerance-ps | Version: 0.0.1 | ||||
| Draft as of 2026-05-19 | Computable Name: CZ_AllergyIntolerancePs | ||||
This profile represents the constraints applied to the AllergyIntolerance resource by the Czech Patient Summary FHIR Implementation Guide. A record of an allergy or intolerance is represented in the patient summary as an instance of an AllergyIntolerance resource constrained by this profile.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
  AllergyIntolerance |
C | 0..* | CZ_AllergyIntolerance | Czech Allergy Intolerance profile Constraints: ait-1, ait-2 | ||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
  Slices for extension |
Content/Rules for all slices | |||||||||
   extension:abatement |
0..1 | (Complex) | When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement | |||||||
   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 | Business identifier for the allergy or intolerance | ||||||
| clinicalStatus |
?!ΣC | 0..1 | CodeableConcept | Current allergy or Intolerance status Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||||
| verificationStatus |
?!ΣC | 0..1 | CodeableConcept | Certainty Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||||
| code |
Σ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: eHDSI Agent or Allergen With Exceptions (preferred)
| ||||||
 patient |
Σ | 1..1 | Reference(Patient (CZ core)(0.4.0)) | Who the allergy or intolerance concerns | ||||||
 Slices for onset[x] |
0..1 | Date of onset of the allergy or intolerance Slice: Unordered, Open by type:$this | ||||||||
| onsetDateTime |
dateTime | |||||||||
| onsetAge |
Age | |||||||||
| onsetPeriod |
Period | |||||||||
| onsetRange |
Range | |||||||||
| onsetString |
string | |||||||||
| onset[x]:onsetDateTime |
0..1 | dateTime | Onset date | |||||||
| Documentation for this format | ||||||||||
| 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.code | Base | preferred | eHDSI Agent or Allergen With Exceptions | 📦0.3.0 | HL7 Czech Terminology Implementation Guide vnull |
| 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()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| AllergyIntolerance |
0..* | CZ_AllergyIntolerance | Czech Allergy Intolerance profile | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | CZ_AllergyIntolerance | Czech Allergy Intolerance profile 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 | ||||||
| language |
0..1 | code | Language of the allergy or intolerance content Binding: CommonLanguages (preferred): A human language.
| |||||||
| 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:abatement |
0..1 | (Complex) | When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement | |||||||
| 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 | Business identifier for the allergy or intolerance | ||||||
| clinicalStatus |
?!ΣC | 0..1 | CodeableConcept | Current allergy or Intolerance status Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||||
| verificationStatus |
?!ΣC | 0..1 | CodeableConcept | Certainty Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||||
| type |
Σ | 0..1 | code | Type of propensity Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||||
| category |
Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||||
| criticality |
Σ | 0..1 | code | Criticality Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||||
| code |
Σ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: eHDSI Agent or Allergen With Exceptions (preferred)
| ||||||
| patient |
Σ | 1..1 | Reference(Patient (CZ core)(0.4.0)) | Who the allergy or intolerance concerns | ||||||
| encounter |
0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |||||||
| Slices for onset[x] |
0..1 | Date of onset of the allergy or intolerance Slice: Unordered, Open by type:$this | ||||||||
| onsetDateTime |
dateTime | |||||||||
| onsetAge |
Age | |||||||||
| onsetPeriod |
Period | |||||||||
| onsetRange |
Range | |||||||||
| onsetString |
string | |||||||||
| onset[x]:onsetDateTime |
0..1 | dateTime | Onset date | |||||||
| recordedDate |
0..1 | dateTime | Date when the allergy or intolerance was recorded | |||||||
| recorder |
0..1 | Reference(Practitioner (CZ core)(0.4.0) | Practitioner Role (CZ core)(0.4.0) | Patient (CZ core)(0.4.0) | Related Person (CZ core)(0.4.0)) | Who recorded the allergy or intolerance | |||||||
| asserter |
Σ | 0..1 | Reference(Patient (CZ core)(0.4.0) | Related Person (CZ core)(0.4.0) | Practitioner (CZ core)(0.4.0) | Practitioner Role (CZ core)(0.4.0)) | Who asserts the allergy or intolerance | ||||||
| lastOccurrence |
0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |||||||
| note |
0..* | Annotation | Additional text not captured in other fields | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
 author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||||
 authorString |
string | |||||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||||
| text |
Σ | 1..1 | markdown | Additional information about the allergy or intolerance | ||||||
| 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: eHDSI Allergen No Drug  (example) | |||||||
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: https://ncez.mzcr.cz/terminology/ValueSet/eHDSI-reaction-allergy (preferred)
| |||||||
| description |
0..1 | string | Description of the event as a whole | |||||||
| onset |
0..1 | dateTime | Reaction onset | |||||||
| severity |
0..1 | code | Reaction severity 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 | |||||||
| Documentation for this format | ||||||||||
| 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 | HL7 Czech Terminology Implementation Guide vnull |
| AllergyIntolerance.reaction.substance | Base | example |
eHDSI Allergen No Drug
|
⏿0.2.0 | tx.hl7europe.eu |
| AllergyIntolerance.reaction.manifestation | Base | preferred | https://ncez.mzcr.cz/terminology/ValueSet/eHDSI-reaction-allergy | Not State | Unknown |
| 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. |
| 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()
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | CZ_AllergyIntolerance | Czech Allergy Intolerance profile Constraints: ait-1, ait-2 | ||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
| Slices for extension |
Content/Rules for all slices | |||||||||
| extension:abatement |
0..1 | (Complex) | When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement | |||||||
| 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 | Business identifier for the allergy or intolerance | ||||||
| clinicalStatus |
?!ΣC | 0..1 | CodeableConcept | Current allergy or Intolerance status Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||||
| verificationStatus |
?!ΣC | 0..1 | CodeableConcept | Certainty Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||||
| code |
Σ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: eHDSI Agent or Allergen With Exceptions (preferred)
| ||||||
| patient |
Σ | 1..1 | Reference(Patient (CZ core)(0.4.0)) | Who the allergy or intolerance concerns | ||||||
| Slices for onset[x] |
0..1 | Date of onset of the allergy or intolerance Slice: Unordered, Open by type:$this | ||||||||
| onsetDateTime |
dateTime | |||||||||
| onsetAge |
Age | |||||||||
| onsetPeriod |
Period | |||||||||
| onsetRange |
Range | |||||||||
| onsetString |
string | |||||||||
| onset[x]:onsetDateTime |
0..1 | dateTime | Onset date | |||||||
| Documentation for this format | ||||||||||
| 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.code | Base | preferred | eHDSI Agent or Allergen With Exceptions | 📦0.3.0 | HL7 Czech Terminology Implementation Guide vnull |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| AllergyIntolerance |
0..* | CZ_AllergyIntolerance | Czech Allergy Intolerance profile | |
| Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance |
C | 0..* | CZ_AllergyIntolerance | Czech Allergy Intolerance profile 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 | ||||||
| language |
0..1 | code | Language of the allergy or intolerance content Binding: CommonLanguages (preferred): A human language.
| |||||||
| 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:abatement |
0..1 | (Complex) | When the allergy or intolerance resolved URL: http://hl7.org/fhir/StructureDefinition/allergyintolerance-abatement | |||||||
| 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 | Business identifier for the allergy or intolerance | ||||||
| clinicalStatus |
?!ΣC | 0..1 | CodeableConcept | Current allergy or Intolerance status Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||||
| verificationStatus |
?!ΣC | 0..1 | CodeableConcept | Certainty Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||||
| type |
Σ | 0..1 | code | Type of propensity Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||||
| category |
Σ | 0..* | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||||
| criticality |
Σ | 0..1 | code | Criticality Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||||
| code |
Σ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: eHDSI Agent or Allergen With Exceptions (preferred)
| ||||||
| patient |
Σ | 1..1 | Reference(Patient (CZ core)(0.4.0)) | Who the allergy or intolerance concerns | ||||||
| encounter |
0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |||||||
| Slices for onset[x] |
0..1 | Date of onset of the allergy or intolerance Slice: Unordered, Open by type:$this | ||||||||
| onsetDateTime |
dateTime | |||||||||
| onsetAge |
Age | |||||||||
| onsetPeriod |
Period | |||||||||
| onsetRange |
Range | |||||||||
| onsetString |
string | |||||||||
| onset[x]:onsetDateTime |
0..1 | dateTime | Onset date | |||||||
| recordedDate |
0..1 | dateTime | Date when the allergy or intolerance was recorded | |||||||
| recorder |
0..1 | Reference(Practitioner (CZ core)(0.4.0) | Practitioner Role (CZ core)(0.4.0) | Patient (CZ core)(0.4.0) | Related Person (CZ core)(0.4.0)) | Who recorded the allergy or intolerance | |||||||
| asserter |
Σ | 0..1 | Reference(Patient (CZ core)(0.4.0) | Related Person (CZ core)(0.4.0) | Practitioner (CZ core)(0.4.0) | Practitioner Role (CZ core)(0.4.0)) | Who asserts the allergy or intolerance | ||||||
| lastOccurrence |
0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |||||||
| note |
0..* | Annotation | Additional text not captured in other fields | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||||
| authorString |
string | |||||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||||
| text |
Σ | 1..1 | markdown | Additional information about the allergy or intolerance | ||||||
| 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: eHDSI Allergen No Drug (example) | |||||||
| manifestation |
1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: https://ncez.mzcr.cz/terminology/ValueSet/eHDSI-reaction-allergy (preferred)
| |||||||
| description |
0..1 | string | Description of the event as a whole | |||||||
| onset |
0..1 | dateTime | Reaction onset | |||||||
| severity |
0..1 | code | Reaction severity 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 | |||||||
| Documentation for this format | ||||||||||
| 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 | HL7 Czech Terminology Implementation Guide vnull |
| AllergyIntolerance.reaction.substance | Base | example |
eHDSI Allergen No Drug
|
⏿0.2.0 | tx.hl7europe.eu |
| AllergyIntolerance.reaction.manifestation | Base | preferred | https://ncez.mzcr.cz/terminology/ValueSet/eHDSI-reaction-allergy | Not State | Unknown |
| 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. |
| 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()
|
Other representations of profile: CSV, Excel, Schematron