Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020 - Local Development build (v0.9.0). See the Directory of published versions
| Official URL: http://nictiz.nl/fhir/StructureDefinition/zib-AllergyIntolerance | Version: 0.9.0 | |||
| Draft as of 2023-10-17 | Computable Name: ZibAllergyIntolerance | |||
Copyright/Legal: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise. |
||||
An allergy or intolerance describes a patient’s tendency towards hypersensitivity to a certain substance, so that an unwanted physiological reaction is expected after exposure to the substance, while most people would not exhibit such a reaction to that amount. The observed physiological changes are usually the result of an immunological reaction. The substances can be categorized as follows:
This AllergyIntolerance resource represents the Dutch zib (‘Zorginformatiebouwsteen’, i.e. Health and Care Information Model) AllergyIntolerance v3.3 (2020).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AllergyIntolerance | 0..* | AllergyIntolerance | This is an abstract profile. Child profiles: NlcoreAllergyIntolerance AllergyIntolerance | |
  clinicalStatus | 0..1 | CodeableConcept | AllergyStatus Binding: AllergyIntoleranceClinicalStatusCodes (required): Use ConceptMap AllergieStatusCodelijst_to_AllergyIntoleranceClinicalStatusCodes to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceClinicalStatusCodes. | |
| verificationStatus | 0..1 | CodeableConcept | AllergyStatus Binding: AllergyIntoleranceVerificationStatusCodes (required): Use ConceptMap AllergieStatusCodelijst_to_AllergyIntoleranceVerificationStatus to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceVerificationStatusCodes. | |
 category | 0..1 | code | AllergyCategory Binding: AllergyIntoleranceCategory (required): Use ConceptMap AllergieCategorieCodelijst_to_AllergyIntoleranceCategory to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceCategory. | |
   allergyCategoryCodelist | 0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |
  value[x] | 0..1 | CodeableConcept | AllergyCategory Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.2--20200901000000 (required) | |
| criticality | 0..1 | code | Criticality Binding: AllergyIntoleranceCriticality (required): Use ConceptMap MateVanKritiekZijnCodelijst_to_AllergyIntoleranceCriticality to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceCriticality. | |
| criticalExtentCodelist | 0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |
| value[x] | 0..1 | CodeableConcept | Criticality Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.4--20200901000000 (required) | |
| code | 0..1 | CodeableConcept | CausativeAgent Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.2--20200901000000 (required) | |
 Slices for onset[x] | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified Slice: Unordered, Open by type:$this | |
 onset[x]:onsetDateTime | 0..1 | dateTime | StartDateTime | |
| lastOccurrence | 0..1 | dateTime | LastReactionDateTime | |
| note | 0..1 | Annotation | Additional text not captured in other fields | |
 text | 1..1 | markdown | Comment | |
| reaction | 0..* | BackboneElement | Reaction | |
| substance | 0..1 | CodeableConcept | SpecificSubstance Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.1--20200901000000 (required) | |
| manifestation | 1..* | CodeableConcept | Symptom Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.5--20200901000000 (extensible) | |
| description | 0..1 | string | ReactionDescription | |
| onset | 0..1 | dateTime | ReactionTime | |
| severity | 0..1 | code | Severity Binding: AllergyIntoleranceSeverity (required): Use ConceptMap ErnstCodelijst_to_AllergyIntoleranceSeverity to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceSeverity. | |
| exposureRoute | 0..1 | CodeableConcept | RouteOfExposure Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.12--20200901000000 (required) | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | C | 0..* | AllergyIntolerance | This is an abstract profile. Child profiles: NlcoreAllergyIntolerance AllergyIntolerance |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 clinicalStatus | ?!ΣC | 0..1 | CodeableConcept | AllergyStatus Binding: AllergyIntoleranceClinicalStatusCodes (required): Use ConceptMap AllergieStatusCodelijst_to_AllergyIntoleranceClinicalStatusCodes to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceClinicalStatusCodes. |
| verificationStatus | ?!ΣC | 0..1 | CodeableConcept | AllergyStatus Binding: AllergyIntoleranceVerificationStatusCodes (required): Use ConceptMap AllergieStatusCodelijst_to_AllergyIntoleranceVerificationStatus to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceVerificationStatusCodes. |
| category | Σ | 0..1 | code | AllergyCategory Binding: AllergyIntoleranceCategory (required): Use ConceptMap AllergieCategorieCodelijst_to_AllergyIntoleranceCategory to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceCategory. |
| allergyCategoryCodelist | 0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |
 url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification" | |
| value[x] | 0..1 | CodeableConcept | AllergyCategory Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.2--20200901000000 (required) | |
| criticality | Σ | 0..1 | code | Criticality Binding: AllergyIntoleranceCriticality (required): Use ConceptMap MateVanKritiekZijnCodelijst_to_AllergyIntoleranceCriticality to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceCriticality. |
| criticalExtentCodelist | 0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification" | |
| value[x] | 0..1 | CodeableConcept | Criticality Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.4--20200901000000 (required) | |
| code | Σ | 0..1 | CodeableConcept | CausativeAgent Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.2--20200901000000 (required) |
 patient | Σ | 1..1 | Reference(Patient) | Who the sensitivity is for |
| Slices for onset[x] | 0..1 | When allergy or intolerance was identified Slice: Unordered, Open by type:$this | ||
 onsetDateTime | dateTime | |||
| onsetAge | Age | |||
| onsetPeriod | Period | |||
| onsetRange | Range | |||
| onsetString | string | |||
| onset[x]:onsetDateTime | 0..1 | dateTime | StartDateTime | |
| lastOccurrence | 0..1 | dateTime | LastReactionDateTime | |
| note | 0..1 | Annotation | Additional text not captured in other fields | |
| text | Σ | 1..1 | markdown | Comment |
| reaction | 0..* | BackboneElement | Reaction | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| substance | 0..1 | CodeableConcept | SpecificSubstance Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.1--20200901000000 (required) | |
| manifestation | 1..* | CodeableConcept | Symptom Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.5--20200901000000 (extensible) | |
| description | 0..1 | string | ReactionDescription | |
| onset | 0..1 | dateTime | ReactionTime | |
| severity | 0..1 | code | Severity Binding: AllergyIntoleranceSeverity (required): Use ConceptMap ErnstCodelijst_to_AllergyIntoleranceSeverity to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceSeverity. | |
| exposureRoute | 0..1 | CodeableConcept | RouteOfExposure Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.12--20200901000000 (required) | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 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 | ||||
|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance | C | 0..* | AllergyIntolerance | This is an abstract profile. Child profiles: NlcoreAllergyIntolerance AllergyIntolerance | ||||
| 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.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | External ids for this item | ||||
| clinicalStatus | ?!ΣC | 0..1 | CodeableConcept | AllergyStatus Binding: AllergyIntoleranceClinicalStatusCodes (required): Use ConceptMap AllergieStatusCodelijst_to_AllergyIntoleranceClinicalStatusCodes to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceClinicalStatusCodes. | ||||
| verificationStatus | ?!ΣC | 0..1 | CodeableConcept | AllergyStatus Binding: AllergyIntoleranceVerificationStatusCodes (required): Use ConceptMap AllergieStatusCodelijst_to_AllergyIntoleranceVerificationStatus to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceVerificationStatusCodes. | ||||
| type | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||
| category | Σ | 0..1 | code | AllergyCategory Binding: AllergyIntoleranceCategory (required): Use ConceptMap AllergieCategorieCodelijst_to_AllergyIntoleranceCategory to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceCategory. | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| allergyCategoryCodelist | 0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification" | |||||
| value[x] | 0..1 | CodeableConcept | AllergyCategory Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.2--20200901000000 (required) | |||||
| value | 0..1 | string | Primitive value for code | |||||
| criticality | Σ | 0..1 | code | Criticality Binding: AllergyIntoleranceCriticality (required): Use ConceptMap MateVanKritiekZijnCodelijst_to_AllergyIntoleranceCriticality to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceCriticality. | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| criticalExtentCodelist | 0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification" | |||||
| value[x] | 0..1 | CodeableConcept | Criticality Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.4--20200901000000 (required) | |||||
| value | 0..1 | string | Primitive value for code | |||||
| code | Σ | 0..1 | CodeableConcept | CausativeAgent Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.2--20200901000000 (required) | ||||
| patient | Σ | 1..1 | Reference(Patient) | Who the sensitivity is for | ||||
| encounter | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |||||
| Slices for onset[x] | 0..1 | When allergy or intolerance was identified Slice: Unordered, Open by type:$this | ||||||
| onsetDateTime | dateTime | |||||||
| onsetAge | Age | |||||||
| onsetPeriod | Period | |||||||
| onsetRange | Range | |||||||
| onsetString | string | |||||||
| onset[x]:onsetDateTime | 0..1 | dateTime | StartDateTime | |||||
| recordedDate | 0..1 | dateTime | Date first version of the resource instance was recorded | |||||
| recorder | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | |||||
| asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy | ||||
| lastOccurrence | 0..1 | dateTime | LastReactionDateTime | |||||
| note | 0..1 | 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 | Comment | ||||
| reaction | 0..* | BackboneElement | Reaction | |||||
| 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 | SpecificSubstance Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.1--20200901000000 (required) | |||||
| manifestation | 1..* | CodeableConcept | Symptom Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.5--20200901000000 (extensible) | |||||
| description | 0..1 | string | ReactionDescription | |||||
| onset | 0..1 | dateTime | ReactionTime | |||||
| severity | 0..1 | code | Severity Binding: AllergyIntoleranceSeverity (required): Use ConceptMap ErnstCodelijst_to_AllergyIntoleranceSeverity to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceSeverity. | |||||
| exposureRoute | 0..1 | CodeableConcept | RouteOfExposure Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.12--20200901000000 (required) | |||||
| note | 0..* | Annotation | Text about event not captured in other fields | |||||
| Documentation for this format | ||||||||
| Id | Grade | Path(s) | Details | Requirements |
| 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 AllergyIntolerance
Summary
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from AllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | 0..* | AllergyIntolerance | This is an abstract profile. Child profiles: NlcoreAllergyIntolerance AllergyIntolerance | |
| clinicalStatus | 0..1 | CodeableConcept | AllergyStatus Binding: AllergyIntoleranceClinicalStatusCodes (required): Use ConceptMap AllergieStatusCodelijst_to_AllergyIntoleranceClinicalStatusCodes to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceClinicalStatusCodes. | |
| verificationStatus | 0..1 | CodeableConcept | AllergyStatus Binding: AllergyIntoleranceVerificationStatusCodes (required): Use ConceptMap AllergieStatusCodelijst_to_AllergyIntoleranceVerificationStatus to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceVerificationStatusCodes. | |
| category | 0..1 | code | AllergyCategory Binding: AllergyIntoleranceCategory (required): Use ConceptMap AllergieCategorieCodelijst_to_AllergyIntoleranceCategory to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceCategory. | |
| allergyCategoryCodelist | 0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |
| value[x] | 0..1 | CodeableConcept | AllergyCategory Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.2--20200901000000 (required) | |
| criticality | 0..1 | code | Criticality Binding: AllergyIntoleranceCriticality (required): Use ConceptMap MateVanKritiekZijnCodelijst_to_AllergyIntoleranceCriticality to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceCriticality. | |
| criticalExtentCodelist | 0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |
| value[x] | 0..1 | CodeableConcept | Criticality Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.4--20200901000000 (required) | |
| code | 0..1 | CodeableConcept | CausativeAgent Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.2--20200901000000 (required) | |
| Slices for onset[x] | 0..1 | dateTime, Age, Period, Range, string | When allergy or intolerance was identified Slice: Unordered, Open by type:$this | |
| onset[x]:onsetDateTime | 0..1 | dateTime | StartDateTime | |
| lastOccurrence | 0..1 | dateTime | LastReactionDateTime | |
| note | 0..1 | Annotation | Additional text not captured in other fields | |
| text | 1..1 | markdown | Comment | |
| reaction | 0..* | BackboneElement | Reaction | |
| substance | 0..1 | CodeableConcept | SpecificSubstance Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.1--20200901000000 (required) | |
| manifestation | 1..* | CodeableConcept | Symptom Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.5--20200901000000 (extensible) | |
| description | 0..1 | string | ReactionDescription | |
| onset | 0..1 | dateTime | ReactionTime | |
| severity | 0..1 | code | Severity Binding: AllergyIntoleranceSeverity (required): Use ConceptMap ErnstCodelijst_to_AllergyIntoleranceSeverity to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceSeverity. | |
| exposureRoute | 0..1 | CodeableConcept | RouteOfExposure Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.12--20200901000000 (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes |
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes |
| AllergyIntolerance.category | required | AllergyIntoleranceCategory |
| AllergyIntolerance.category.extension:allergyCategoryCodelist.value[x] | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.2--20200901000000 |
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality |
| AllergyIntolerance.criticality.extension:criticalExtentCodelist.value[x] | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.4--20200901000000 |
| AllergyIntolerance.code | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.2--20200901000000 |
| AllergyIntolerance.reaction.substance | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.1--20200901000000 |
| AllergyIntolerance.reaction.manifestation | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.5--20200901000000 |
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity |
| AllergyIntolerance.reaction.exposureRoute | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.12--20200901000000 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | C | 0..* | AllergyIntolerance | This is an abstract profile. Child profiles: NlcoreAllergyIntolerance AllergyIntolerance |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| clinicalStatus | ?!ΣC | 0..1 | CodeableConcept | AllergyStatus Binding: AllergyIntoleranceClinicalStatusCodes (required): Use ConceptMap AllergieStatusCodelijst_to_AllergyIntoleranceClinicalStatusCodes to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceClinicalStatusCodes. |
| verificationStatus | ?!ΣC | 0..1 | CodeableConcept | AllergyStatus Binding: AllergyIntoleranceVerificationStatusCodes (required): Use ConceptMap AllergieStatusCodelijst_to_AllergyIntoleranceVerificationStatus to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceVerificationStatusCodes. |
| category | Σ | 0..1 | code | AllergyCategory Binding: AllergyIntoleranceCategory (required): Use ConceptMap AllergieCategorieCodelijst_to_AllergyIntoleranceCategory to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceCategory. |
| allergyCategoryCodelist | 0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification" | |
| value[x] | 0..1 | CodeableConcept | AllergyCategory Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.2--20200901000000 (required) | |
| criticality | Σ | 0..1 | code | Criticality Binding: AllergyIntoleranceCriticality (required): Use ConceptMap MateVanKritiekZijnCodelijst_to_AllergyIntoleranceCriticality to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceCriticality. |
| criticalExtentCodelist | 0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification" | |
| value[x] | 0..1 | CodeableConcept | Criticality Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.4--20200901000000 (required) | |
| code | Σ | 0..1 | CodeableConcept | CausativeAgent Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.2--20200901000000 (required) |
| patient | Σ | 1..1 | Reference(Patient) | Who the sensitivity is for |
| Slices for onset[x] | 0..1 | When allergy or intolerance was identified Slice: Unordered, Open by type:$this | ||
| onsetDateTime | dateTime | |||
| onsetAge | Age | |||
| onsetPeriod | Period | |||
| onsetRange | Range | |||
| onsetString | string | |||
| onset[x]:onsetDateTime | 0..1 | dateTime | StartDateTime | |
| lastOccurrence | 0..1 | dateTime | LastReactionDateTime | |
| note | 0..1 | Annotation | Additional text not captured in other fields | |
| text | Σ | 1..1 | markdown | Comment |
| reaction | 0..* | BackboneElement | Reaction | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| substance | 0..1 | CodeableConcept | SpecificSubstance Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.1--20200901000000 (required) | |
| manifestation | 1..* | CodeableConcept | Symptom Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.5--20200901000000 (extensible) | |
| description | 0..1 | string | ReactionDescription | |
| onset | 0..1 | dateTime | ReactionTime | |
| severity | 0..1 | code | Severity Binding: AllergyIntoleranceSeverity (required): Use ConceptMap ErnstCodelijst_to_AllergyIntoleranceSeverity to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceSeverity. | |
| exposureRoute | 0..1 | CodeableConcept | RouteOfExposure Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.12--20200901000000 (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes |
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes |
| AllergyIntolerance.category | required | AllergyIntoleranceCategory |
| AllergyIntolerance.category.extension:allergyCategoryCodelist.value[x] | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.2--20200901000000 |
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality |
| AllergyIntolerance.criticality.extension:criticalExtentCodelist.value[x] | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.4--20200901000000 |
| AllergyIntolerance.code | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.2--20200901000000 |
| AllergyIntolerance.reaction.substance | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.1--20200901000000 |
| AllergyIntolerance.reaction.manifestation | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.5--20200901000000 |
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity |
| AllergyIntolerance.reaction.exposureRoute | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.12--20200901000000 |
| Id | Grade | Path(s) | Details | Requirements |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance | C | 0..* | AllergyIntolerance | This is an abstract profile. Child profiles: NlcoreAllergyIntolerance AllergyIntolerance | ||||
| 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.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | External ids for this item | ||||
| clinicalStatus | ?!ΣC | 0..1 | CodeableConcept | AllergyStatus Binding: AllergyIntoleranceClinicalStatusCodes (required): Use ConceptMap AllergieStatusCodelijst_to_AllergyIntoleranceClinicalStatusCodes to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceClinicalStatusCodes. | ||||
| verificationStatus | ?!ΣC | 0..1 | CodeableConcept | AllergyStatus Binding: AllergyIntoleranceVerificationStatusCodes (required): Use ConceptMap AllergieStatusCodelijst_to_AllergyIntoleranceVerificationStatus to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceVerificationStatusCodes. | ||||
| type | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||
| category | Σ | 0..1 | code | AllergyCategory Binding: AllergyIntoleranceCategory (required): Use ConceptMap AllergieCategorieCodelijst_to_AllergyIntoleranceCategory to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceCategory. | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| allergyCategoryCodelist | 0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification" | |||||
| value[x] | 0..1 | CodeableConcept | AllergyCategory Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.2--20200901000000 (required) | |||||
| value | 0..1 | string | Primitive value for code | |||||
| criticality | Σ | 0..1 | code | Criticality Binding: AllergyIntoleranceCriticality (required): Use ConceptMap MateVanKritiekZijnCodelijst_to_AllergyIntoleranceCriticality to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceCriticality. | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| criticalExtentCodelist | 0..1 | CodeableConcept | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-CodeSpecification" | |||||
| value[x] | 0..1 | CodeableConcept | Criticality Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.4--20200901000000 (required) | |||||
| value | 0..1 | string | Primitive value for code | |||||
| code | Σ | 0..1 | CodeableConcept | CausativeAgent Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.2--20200901000000 (required) | ||||
| patient | Σ | 1..1 | Reference(Patient) | Who the sensitivity is for | ||||
| encounter | 0..1 | Reference(Encounter) | Encounter when the allergy or intolerance was asserted | |||||
| Slices for onset[x] | 0..1 | When allergy or intolerance was identified Slice: Unordered, Open by type:$this | ||||||
| onsetDateTime | dateTime | |||||||
| onsetAge | Age | |||||||
| onsetPeriod | Period | |||||||
| onsetRange | Range | |||||||
| onsetString | string | |||||||
| onset[x]:onsetDateTime | 0..1 | dateTime | StartDateTime | |||||
| recordedDate | 0..1 | dateTime | Date first version of the resource instance was recorded | |||||
| recorder | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | Who recorded the sensitivity | |||||
| asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy | ||||
| lastOccurrence | 0..1 | dateTime | LastReactionDateTime | |||||
| note | 0..1 | 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 | Comment | ||||
| reaction | 0..* | BackboneElement | Reaction | |||||
| 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 | SpecificSubstance Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.1--20200901000000 (required) | |||||
| manifestation | 1..* | CodeableConcept | Symptom Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.5--20200901000000 (extensible) | |||||
| description | 0..1 | string | ReactionDescription | |||||
| onset | 0..1 | dateTime | ReactionTime | |||||
| severity | 0..1 | code | Severity Binding: AllergyIntoleranceSeverity (required): Use ConceptMap ErnstCodelijst_to_AllergyIntoleranceSeverity to translate terminology from the functional model to profile terminology in ValueSet AllergyIntoleranceSeverity. | |||||
| exposureRoute | 0..1 | CodeableConcept | RouteOfExposure Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.12--20200901000000 (required) | |||||
| note | 0..* | Annotation | Text about event not captured in other fields | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| AllergyIntolerance.language | preferred | CommonLanguages
| ||||
| AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes | ||||
| AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes | ||||
| AllergyIntolerance.type | required | AllergyIntoleranceType | ||||
| AllergyIntolerance.category | required | AllergyIntoleranceCategory | ||||
| AllergyIntolerance.category.extension:allergyCategoryCodelist.value[x] | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.2--20200901000000 | ||||
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality | ||||
| AllergyIntolerance.criticality.extension:criticalExtentCodelist.value[x] | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.4--20200901000000 | ||||
| AllergyIntolerance.code | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.2--20200901000000 | ||||
| AllergyIntolerance.reaction.substance | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.121.11.1--20200901000000 | ||||
| AllergyIntolerance.reaction.manifestation | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.5--20200901000000 | ||||
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity | ||||
| AllergyIntolerance.reaction.exposureRoute | required | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.8.2.12--20200901000000 |
| Id | Grade | Path(s) | Details | Requirements |
| 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 AllergyIntolerance
Summary
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron