New Zealand MWS IG
1.1.5 - Release

New Zealand MWS IG - Local Development build (v1.1.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: MwsAllergyIntolerance

Official URL: http://hl7.org.nz/fhir/StructureDefinition/MwsAllergyIntolerance | Version: 1.1.5
Active as of 2025-05-06 | Computable Name: MwsAllergyIntolerance

The AllergyIntolerance resource exposed by the MWS. This contains information related to allergy and adverse drug reactions for a patient.

### MWS Profile

MWS AllergyIntolerance resource represents the nationally held allergy and adverse drug reactions for a patient.

It includes the following attributes

- clinicalStatus
- verificationStatus
- category
- patient (NHI)
- substance
- reaction manifestations
- onsetDate
- Recorder
- Recorded date
- notes

Other attributes from the standard profile maybe considered for future releases.

### RecordedDate

MWS populates this date from the system date when the record is created or updated.
It must not be supplied on create.

### Recorder

Recorder has 3 parts organisation, facility/location and person/practitioner.
The facility and person are required. The organisation is optional.
Each are represented by an HPI identifier. HPI Organisation ID, HPI Facility ID and HPI CPN.
Currently only an HPI CPN is acceptable – If HPI responsible authority ID eg medical council number is preferred please provide that feedback.
Where the recorder is a person without an HPI CPN then a local identifier must be supplied.

### Category

The category is mandatory and must be derived from the code that a user has selected. It should not be user entered.

Usage:

- Examples for this Resource Profile: AllergyIntolerance/13831, AllergyIntolerance/AI667788899, AllergyIntolerance/MwsAllergyIntolerance-2, AllergyIntolerance/MwsAllergyIntolerance-3 and AllergyIntolerance/MwsAllergyIntolerance-4
- CapabilityStatements using this Resource Profile: CapabilityStatement[http://hl7.org.nz/fhir/ig/mws/CapabilityStatement/MWSCapabilityStatement|1.1.5]

### Formal Views of Profile Content

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

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

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management URL-LENGTH: URLs must be less than 1024 characters URL-ALLOWED-CHARS: character restrictions for URLs SYSTEM-LENGTH: System URLs must be less than 1024 characters SYSTEM-ALLOWED-CHARS: character restrictions for system url CODEABLE-CONCEPT-TEXT-LENGTH: valueCodeableConcept.text must be less than 1024 characters CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS: character restrictions for valueCodeableConcept.text NOTE-LENGTH: System URLs must be less than 1024 characters NOTE-ALLOWED-CHARS: character restrictions for system notes -excluding special characters which may be used for xss
contained |  | 0..2 |  | Contained, inline Resources
contained |  |  | PractitionerRole |
contained |  |  | Patient |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
clinicalStatus | ?!Σ C | 0..1 | CodeableConcept | active | inactive Binding: MWS Clinical status (required) ele-1: All FHIR elements must have a @value or children
verificationStatus | ?!Σ C | 0..1 | CodeableConcept | refuted | entered-in-error Binding: MWS verification status (required) ele-1: All FHIR elements must have a @value or children
category | Σ | 0..1 | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. ele-1: All FHIR elements must have a @value or children
code | Σ | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: NZULM codes (required) ele-1: All FHIR elements must have a @value or children
patient | Σ | 1..1 | Reference(Mws Patient) | Who the sensitivity is for ele-1: All FHIR elements must have a @value or children
onset[x] |  | 0..1 | dateTime | When allergy or intolerance was identified ele-1: All FHIR elements must have a @value or children
recorder |  | 0..1 | Reference(PractitionerRole) | Who recorded the sensitivity ele-1: All FHIR elements must have a @value or children
note |  | 0..1 | Annotation | Additional text not captured in other fields ele-1: All FHIR elements must have a @value or children
reaction |  | 0..1 | BackboneElement | Adverse Reaction Events linked to exposure to substance ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
manifestation |  | 1..50 | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: http://snomed.info/sct/21000210109/version/20240401?fhir_vs=refset%2F351000210106 (required) ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
AllergyIntolerance.clinicalStatus | required | Mws_clinical_status `https://nzhts.digital.health.nz/fhir/ValueSet/mws-clinical-status`
AllergyIntolerance.verificationStatus | required | Mws_verification_status `https://nzhts.digital.health.nz/fhir/ValueSet/mws-verification-status`
AllergyIntolerance.category | required | AllergyIntoleranceCategory `http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1` from the FHIR Standard
AllergyIntolerance.code | required | Mws_substance_combined `https://nzhts.digital.health.nz/fhir/ValueSet/mws-substance-combined`
AllergyIntolerance.reaction.manifestation | required | http://snomed.info/sct/21000210109/version/20240401?fhir_vs=refset%2F351000210106 `http://snomed.info/sct/21000210109/version/20240401?fhir_vs=refset%2F351000210106`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for valueCodeableConcept.text : AllergyIntolerance.descendants().valueCodeableConcept.text.all(matches('^([-a-zA-Z0-9\' \t\r\n.\/,])*$')) |
CODEABLE-CONCEPT-TEXT-LENGTH | error | AllergyIntolerance | valueCodeableConcept.text must be less than 1024 characters : AllergyIntolerance.descendants().valueCodeableConcept.text.all(length()<1024) |
NOTE-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for system notes -excluding special characters which may be used for xss : AllergyIntolerance.note.text.all(matches('^.*\u003c|\u003e|\u0022|\u0027.*$').not()) |
NOTE-LENGTH | error | AllergyIntolerance | System URLs must be less than 1024 characters : AllergyIntolerance.note.text.all(length()<1024) |
SYSTEM-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for system url : AllergyIntolerance.descendants().system.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) |
SYSTEM-LENGTH | error | AllergyIntolerance | System URLs must be less than 1024 characters : AllergyIntolerance.descendants().system.all(length()<1024) |
URL-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for URLs : AllergyIntolerance.descendants().url.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) |
URL-LENGTH | error | AllergyIntolerance | URLs must be less than 1024 characters : AllergyIntolerance.descendants().url.all(length()<1024) |

This structure is derived from AllergyIntolerance

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) URL-LENGTH: URLs must be less than 1024 characters URL-ALLOWED-CHARS: character restrictions for URLs SYSTEM-LENGTH: System URLs must be less than 1024 characters SYSTEM-ALLOWED-CHARS: character restrictions for system url CODEABLE-CONCEPT-TEXT-LENGTH: valueCodeableConcept.text must be less than 1024 characters CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS: character restrictions for valueCodeableConcept.text NOTE-LENGTH: System URLs must be less than 1024 characters NOTE-ALLOWED-CHARS: character restrictions for system notes -excluding special characters which may be used for xss
implicitRules |  | 0..0 |  |
language |  | 0..0 |  |
contained |  | 0..2 |  | Contained, inline Resources
contained |  |  | PractitionerRole |
contained |  |  | Patient |
clinicalStatus |  | 0..1 | CodeableConcept | active | inactive Binding: MWS Clinical status (required)
verificationStatus |  | 0..1 | CodeableConcept | refuted | entered-in-error Binding: MWS verification status (required)
type |  | 0..0 |  |
category |  | 0..1 | code | food | medication | environment | biologic
criticality |  | 0..0 |  |
code |  | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: NZULM codes (required)
patient |  | 1..1 | Reference(Mws Patient) | Who the sensitivity is for
encounter |  | 0..0 |  |
onset[x] |  | 0..1 | dateTime | When allergy or intolerance was identified
recorder |  | 0..1 | Reference(PractitionerRole) | Who recorded the sensitivity
asserter |  | 0..0 |  |
lastOccurrence |  | 0..0 |  |
note |  | 0..1 | Annotation | Additional text not captured in other fields
reaction |  | 0..1 | BackboneElement | Adverse Reaction Events linked to exposure to substance
substance |  | 0..0 |  |
manifestation |  | 1..50 | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: http://snomed.info/sct/21000210109/version/20240401?fhir_vs=refset%2F351000210106 (required)
description |  | 0..0 |  |
onset |  | 0..0 |  |
severity |  | 0..0 |  |
exposureRoute |  | 0..0 |  |
note |  | 0..0 |  |
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
AllergyIntolerance.clinicalStatus | required | Mws_clinical_status `https://nzhts.digital.health.nz/fhir/ValueSet/mws-clinical-status`
AllergyIntolerance.verificationStatus | required | Mws_verification_status `https://nzhts.digital.health.nz/fhir/ValueSet/mws-verification-status`
AllergyIntolerance.code | required | Mws_substance_combined `https://nzhts.digital.health.nz/fhir/ValueSet/mws-substance-combined`
AllergyIntolerance.reaction.manifestation | required | http://snomed.info/sct/21000210109/version/20240401?fhir_vs=refset%2F351000210106 `http://snomed.info/sct/21000210109/version/20240401?fhir_vs=refset%2F351000210106`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for valueCodeableConcept.text : AllergyIntolerance.descendants().valueCodeableConcept.text.all(matches('^([-a-zA-Z0-9\' \t\r\n.\/,])*$')) |
CODEABLE-CONCEPT-TEXT-LENGTH | error | AllergyIntolerance | valueCodeableConcept.text must be less than 1024 characters : AllergyIntolerance.descendants().valueCodeableConcept.text.all(length()<1024) |
NOTE-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for system notes -excluding special characters which may be used for xss : AllergyIntolerance.note.text.all(matches('^.*\u003c|\u003e|\u0022|\u0027.*$').not()) |
NOTE-LENGTH | error | AllergyIntolerance | System URLs must be less than 1024 characters : AllergyIntolerance.note.text.all(length()<1024) |
SYSTEM-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for system url : AllergyIntolerance.descendants().system.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) |
SYSTEM-LENGTH | error | AllergyIntolerance | System URLs must be less than 1024 characters : AllergyIntolerance.descendants().system.all(length()<1024) |
URL-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for URLs : AllergyIntolerance.descendants().url.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) |
URL-LENGTH | error | AllergyIntolerance | URLs must be less than 1024 characters : AllergyIntolerance.descendants().url.all(length()<1024) |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error URL-LENGTH: URLs must be less than 1024 characters URL-ALLOWED-CHARS: character restrictions for URLs SYSTEM-LENGTH: System URLs must be less than 1024 characters SYSTEM-ALLOWED-CHARS: character restrictions for system url CODEABLE-CONCEPT-TEXT-LENGTH: valueCodeableConcept.text must be less than 1024 characters CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS: character restrictions for valueCodeableConcept.text NOTE-LENGTH: System URLs must be less than 1024 characters NOTE-ALLOWED-CHARS: character restrictions for system notes -excluding special characters which may be used for xss
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..2 |  | Contained, inline Resources
contained |  |  | PractitionerRole |
contained |  |  | Patient |
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 | active | inactive Binding: MWS Clinical status (required)
verificationStatus | ?!Σ C | 0..1 | CodeableConcept | refuted | entered-in-error Binding: MWS verification status (required)
category | Σ | 0..1 | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
code | Σ | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: NZULM codes (required)
patient | Σ | 1..1 | Reference(Mws Patient) | Who the sensitivity is for
onset[x] |  | 0..1 | dateTime | When allergy or intolerance was identified
recordedDate |  | 0..1 | dateTime | Date first version of the resource instance was recorded
recorder |  | 0..1 | Reference(PractitionerRole) | Who recorded the sensitivity
note |  | 0..1 | Annotation | Additional text not captured in other fields
reaction |  | 0..1 | 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
manifestation |  | 1..50 | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: http://snomed.info/sct/21000210109/version/20240401?fhir_vs=refset%2F351000210106 (required)
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
AllergyIntolerance.clinicalStatus | required | Mws_clinical_status `https://nzhts.digital.health.nz/fhir/ValueSet/mws-clinical-status`
AllergyIntolerance.verificationStatus | required | Mws_verification_status `https://nzhts.digital.health.nz/fhir/ValueSet/mws-verification-status`
AllergyIntolerance.category | required | AllergyIntoleranceCategory `http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1` from the FHIR Standard
AllergyIntolerance.code | required | Mws_substance_combined `https://nzhts.digital.health.nz/fhir/ValueSet/mws-substance-combined`
AllergyIntolerance.reaction.manifestation | required | http://snomed.info/sct/21000210109/version/20240401?fhir_vs=refset%2F351000210106 `http://snomed.info/sct/21000210109/version/20240401?fhir_vs=refset%2F351000210106`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for valueCodeableConcept.text : AllergyIntolerance.descendants().valueCodeableConcept.text.all(matches('^([-a-zA-Z0-9\' \t\r\n.\/,])*$')) |
CODEABLE-CONCEPT-TEXT-LENGTH | error | AllergyIntolerance | valueCodeableConcept.text must be less than 1024 characters : AllergyIntolerance.descendants().valueCodeableConcept.text.all(length()<1024) |
NOTE-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for system notes -excluding special characters which may be used for xss : AllergyIntolerance.note.text.all(matches('^.*\u003c|\u003e|\u0022|\u0027.*$').not()) |
NOTE-LENGTH | error | AllergyIntolerance | System URLs must be less than 1024 characters : AllergyIntolerance.note.text.all(length()<1024) |
SYSTEM-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for system url : AllergyIntolerance.descendants().system.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) |
SYSTEM-LENGTH | error | AllergyIntolerance | System URLs must be less than 1024 characters : AllergyIntolerance.descendants().system.all(length()<1024) |
URL-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for URLs : AllergyIntolerance.descendants().url.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) |
URL-LENGTH | error | AllergyIntolerance | URLs must be less than 1024 characters : AllergyIntolerance.descendants().url.all(length()<1024) |

This structure is derived from AllergyIntolerance

Summary

Prohibited: 13 elements

Structures

This structure refers to these other structures:

- Mws Patient (http://hl7.org.nz/fhir/StructureDefinition/MwsPatient)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management URL-LENGTH: URLs must be less than 1024 characters URL-ALLOWED-CHARS: character restrictions for URLs SYSTEM-LENGTH: System URLs must be less than 1024 characters SYSTEM-ALLOWED-CHARS: character restrictions for system url CODEABLE-CONCEPT-TEXT-LENGTH: valueCodeableConcept.text must be less than 1024 characters CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS: character restrictions for valueCodeableConcept.text NOTE-LENGTH: System URLs must be less than 1024 characters NOTE-ALLOWED-CHARS: character restrictions for system notes -excluding special characters which may be used for xss
contained |  | 0..2 |  | Contained, inline Resources
contained |  |  | PractitionerRole |
contained |  |  | Patient |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
clinicalStatus | ?!Σ C | 0..1 | CodeableConcept | active | inactive Binding: MWS Clinical status (required) ele-1: All FHIR elements must have a @value or children
verificationStatus | ?!Σ C | 0..1 | CodeableConcept | refuted | entered-in-error Binding: MWS verification status (required) ele-1: All FHIR elements must have a @value or children
category | Σ | 0..1 | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. ele-1: All FHIR elements must have a @value or children
code | Σ | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: NZULM codes (required) ele-1: All FHIR elements must have a @value or children
patient | Σ | 1..1 | Reference(Mws Patient) | Who the sensitivity is for ele-1: All FHIR elements must have a @value or children
onset[x] |  | 0..1 | dateTime | When allergy or intolerance was identified ele-1: All FHIR elements must have a @value or children
recorder |  | 0..1 | Reference(PractitionerRole) | Who recorded the sensitivity ele-1: All FHIR elements must have a @value or children
note |  | 0..1 | Annotation | Additional text not captured in other fields ele-1: All FHIR elements must have a @value or children
reaction |  | 0..1 | BackboneElement | Adverse Reaction Events linked to exposure to substance ele-1: All FHIR elements must have a @value or children
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
manifestation |  | 1..50 | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: http://snomed.info/sct/21000210109/version/20240401?fhir_vs=refset%2F351000210106 (required) ele-1: All FHIR elements must have a @value or children
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
AllergyIntolerance.clinicalStatus | required | Mws_clinical_status `https://nzhts.digital.health.nz/fhir/ValueSet/mws-clinical-status`
AllergyIntolerance.verificationStatus | required | Mws_verification_status `https://nzhts.digital.health.nz/fhir/ValueSet/mws-verification-status`
AllergyIntolerance.category | required | AllergyIntoleranceCategory `http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1` from the FHIR Standard
AllergyIntolerance.code | required | Mws_substance_combined `https://nzhts.digital.health.nz/fhir/ValueSet/mws-substance-combined`
AllergyIntolerance.reaction.manifestation | required | http://snomed.info/sct/21000210109/version/20240401?fhir_vs=refset%2F351000210106 `http://snomed.info/sct/21000210109/version/20240401?fhir_vs=refset%2F351000210106`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for valueCodeableConcept.text : AllergyIntolerance.descendants().valueCodeableConcept.text.all(matches('^([-a-zA-Z0-9\' \t\r\n.\/,])*$')) |
CODEABLE-CONCEPT-TEXT-LENGTH | error | AllergyIntolerance | valueCodeableConcept.text must be less than 1024 characters : AllergyIntolerance.descendants().valueCodeableConcept.text.all(length()<1024) |
NOTE-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for system notes -excluding special characters which may be used for xss : AllergyIntolerance.note.text.all(matches('^.*\u003c|\u003e|\u0022|\u0027.*$').not()) |
NOTE-LENGTH | error | AllergyIntolerance | System URLs must be less than 1024 characters : AllergyIntolerance.note.text.all(length()<1024) |
SYSTEM-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for system url : AllergyIntolerance.descendants().system.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) |
SYSTEM-LENGTH | error | AllergyIntolerance | System URLs must be less than 1024 characters : AllergyIntolerance.descendants().system.all(length()<1024) |
URL-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for URLs : AllergyIntolerance.descendants().url.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) |
URL-LENGTH | error | AllergyIntolerance | URLs must be less than 1024 characters : AllergyIntolerance.descendants().url.all(length()<1024) |

Differential View

This structure is derived from AllergyIntolerance

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) URL-LENGTH: URLs must be less than 1024 characters URL-ALLOWED-CHARS: character restrictions for URLs SYSTEM-LENGTH: System URLs must be less than 1024 characters SYSTEM-ALLOWED-CHARS: character restrictions for system url CODEABLE-CONCEPT-TEXT-LENGTH: valueCodeableConcept.text must be less than 1024 characters CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS: character restrictions for valueCodeableConcept.text NOTE-LENGTH: System URLs must be less than 1024 characters NOTE-ALLOWED-CHARS: character restrictions for system notes -excluding special characters which may be used for xss
implicitRules |  | 0..0 |  |
language |  | 0..0 |  |
contained |  | 0..2 |  | Contained, inline Resources
contained |  |  | PractitionerRole |
contained |  |  | Patient |
clinicalStatus |  | 0..1 | CodeableConcept | active | inactive Binding: MWS Clinical status (required)
verificationStatus |  | 0..1 | CodeableConcept | refuted | entered-in-error Binding: MWS verification status (required)
type |  | 0..0 |  |
category |  | 0..1 | code | food | medication | environment | biologic
criticality |  | 0..0 |  |
code |  | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: NZULM codes (required)
patient |  | 1..1 | Reference(Mws Patient) | Who the sensitivity is for
encounter |  | 0..0 |  |
onset[x] |  | 0..1 | dateTime | When allergy or intolerance was identified
recorder |  | 0..1 | Reference(PractitionerRole) | Who recorded the sensitivity
asserter |  | 0..0 |  |
lastOccurrence |  | 0..0 |  |
note |  | 0..1 | Annotation | Additional text not captured in other fields
reaction |  | 0..1 | BackboneElement | Adverse Reaction Events linked to exposure to substance
substance |  | 0..0 |  |
manifestation |  | 1..50 | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: http://snomed.info/sct/21000210109/version/20240401?fhir_vs=refset%2F351000210106 (required)
description |  | 0..0 |  |
onset |  | 0..0 |  |
severity |  | 0..0 |  |
exposureRoute |  | 0..0 |  |
note |  | 0..0 |  |
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
AllergyIntolerance.clinicalStatus | required | Mws_clinical_status `https://nzhts.digital.health.nz/fhir/ValueSet/mws-clinical-status`
AllergyIntolerance.verificationStatus | required | Mws_verification_status `https://nzhts.digital.health.nz/fhir/ValueSet/mws-verification-status`
AllergyIntolerance.code | required | Mws_substance_combined `https://nzhts.digital.health.nz/fhir/ValueSet/mws-substance-combined`
AllergyIntolerance.reaction.manifestation | required | http://snomed.info/sct/21000210109/version/20240401?fhir_vs=refset%2F351000210106 `http://snomed.info/sct/21000210109/version/20240401?fhir_vs=refset%2F351000210106`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for valueCodeableConcept.text : AllergyIntolerance.descendants().valueCodeableConcept.text.all(matches('^([-a-zA-Z0-9\' \t\r\n.\/,])*$')) |
CODEABLE-CONCEPT-TEXT-LENGTH | error | AllergyIntolerance | valueCodeableConcept.text must be less than 1024 characters : AllergyIntolerance.descendants().valueCodeableConcept.text.all(length()<1024) |
NOTE-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for system notes -excluding special characters which may be used for xss : AllergyIntolerance.note.text.all(matches('^.*\u003c|\u003e|\u0022|\u0027.*$').not()) |
NOTE-LENGTH | error | AllergyIntolerance | System URLs must be less than 1024 characters : AllergyIntolerance.note.text.all(length()<1024) |
SYSTEM-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for system url : AllergyIntolerance.descendants().system.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) |
SYSTEM-LENGTH | error | AllergyIntolerance | System URLs must be less than 1024 characters : AllergyIntolerance.descendants().system.all(length()<1024) |
URL-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for URLs : AllergyIntolerance.descendants().url.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) |
URL-LENGTH | error | AllergyIntolerance | URLs must be less than 1024 characters : AllergyIntolerance.descendants().url.all(length()<1024) |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
AllergyIntolerance | C | 0..* | AllergyIntolerance | Allergy or Intolerance (generally: Risk of adverse reaction to a substance) ait-1: AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. ait-2: AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error URL-LENGTH: URLs must be less than 1024 characters URL-ALLOWED-CHARS: character restrictions for URLs SYSTEM-LENGTH: System URLs must be less than 1024 characters SYSTEM-ALLOWED-CHARS: character restrictions for system url CODEABLE-CONCEPT-TEXT-LENGTH: valueCodeableConcept.text must be less than 1024 characters CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS: character restrictions for valueCodeableConcept.text NOTE-LENGTH: System URLs must be less than 1024 characters NOTE-ALLOWED-CHARS: character restrictions for system notes -excluding special characters which may be used for xss
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..2 |  | Contained, inline Resources
contained |  |  | PractitionerRole |
contained |  |  | Patient |
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 | active | inactive Binding: MWS Clinical status (required)
verificationStatus | ?!Σ C | 0..1 | CodeableConcept | refuted | entered-in-error Binding: MWS verification status (required)
category | Σ | 0..1 | code | food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances.
code | Σ | 0..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: NZULM codes (required)
patient | Σ | 1..1 | Reference(Mws Patient) | Who the sensitivity is for
onset[x] |  | 0..1 | dateTime | When allergy or intolerance was identified
recordedDate |  | 0..1 | dateTime | Date first version of the resource instance was recorded
recorder |  | 0..1 | Reference(PractitionerRole) | Who recorded the sensitivity
note |  | 0..1 | Annotation | Additional text not captured in other fields
reaction |  | 0..1 | 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
manifestation |  | 1..50 | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: http://snomed.info/sct/21000210109/version/20240401?fhir_vs=refset%2F351000210106 (required)
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
AllergyIntolerance.clinicalStatus | required | Mws_clinical_status `https://nzhts.digital.health.nz/fhir/ValueSet/mws-clinical-status`
AllergyIntolerance.verificationStatus | required | Mws_verification_status `https://nzhts.digital.health.nz/fhir/ValueSet/mws-verification-status`
AllergyIntolerance.category | required | AllergyIntoleranceCategory `http://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1` from the FHIR Standard
AllergyIntolerance.code | required | Mws_substance_combined `https://nzhts.digital.health.nz/fhir/ValueSet/mws-substance-combined`
AllergyIntolerance.reaction.manifestation | required | http://snomed.info/sct/21000210109/version/20240401?fhir_vs=refset%2F351000210106 `http://snomed.info/sct/21000210109/version/20240401?fhir_vs=refset%2F351000210106`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
CODEABLE-CONCEPT-TEXT-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for valueCodeableConcept.text : AllergyIntolerance.descendants().valueCodeableConcept.text.all(matches('^([-a-zA-Z0-9\' \t\r\n.\/,])*$')) |
CODEABLE-CONCEPT-TEXT-LENGTH | error | AllergyIntolerance | valueCodeableConcept.text must be less than 1024 characters : AllergyIntolerance.descendants().valueCodeableConcept.text.all(length()<1024) |
NOTE-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for system notes -excluding special characters which may be used for xss : AllergyIntolerance.note.text.all(matches('^.*\u003c|\u003e|\u0022|\u0027.*$').not()) |
NOTE-LENGTH | error | AllergyIntolerance | System URLs must be less than 1024 characters : AllergyIntolerance.note.text.all(length()<1024) |
SYSTEM-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for system url : AllergyIntolerance.descendants().system.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) |
SYSTEM-LENGTH | error | AllergyIntolerance | System URLs must be less than 1024 characters : AllergyIntolerance.descendants().system.all(length()<1024) |
URL-ALLOWED-CHARS | error | AllergyIntolerance | character restrictions for URLs : AllergyIntolerance.descendants().url.all(matches('^[-a-zA-Z0-9@:%._~#=?&\/]*$')) |
URL-LENGTH | error | AllergyIntolerance | URLs must be less than 1024 characters : AllergyIntolerance.descendants().url.all(length()<1024) |

This structure is derived from AllergyIntolerance

Summary

Prohibited: 13 elements

Structures

This structure refers to these other structures:

- Mws Patient (http://hl7.org.nz/fhir/StructureDefinition/MwsPatient)

Other representations of profile: CSV, Excel, Schematron