MediRecords FHIR Implementation Guide
1.4.1 - release
| Defining URL: | https://fhir.medirecords.com/StructureDefinition/mr-allergy-intolerance |
| Version: | 1.4.1 |
| Name: | MRAllergyIntolerance |
| Title: | MR AllergyIntolerance |
| Status: | Active as of 2024-10-28 02:34:31+0000 |
| Definition: | MediRecords AllergyIntolerance profile to represent clinical statements about adverse reactions |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://fhir.medirecords.com/StructureDefinition/mr-allergy-intolerance
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseAllergyIntolerance
Summary
Mandatory: 1 element (1 nested mandatory element)
Must-Support: 10 elements
Structures
This structure refers to these other structures:
This structure is derived from AUBaseAllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  AllergyIntolerance | C | 0..* | AUBaseAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context inv-mr-allergyintolerance-noknownallergy-reaction: AllergyIntolerance.reaction must exist unless code is 'No known allergy' |
  meta | ||||
  lastUpdated | S | 0..1 | instant | When the resource version last changed |
 profile | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| clinicalStatus | S | 0..1 | CodeableConcept | Medirecords supports only active status Required Pattern: At least the following |
  coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: active | |
| verificationStatus | S | 0..1 | CodeableConcept | Medirecords supports only confirmed verificationStatus Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: confirmed | |
| category | 0..1 | code | Medirecords supports only medication category | |
| code | S | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance |
| text | 0..1 | string | Plain text representation of the concept Max Length: 300 | |
 patient | S | 1..1 | Reference(MR Patient) | Who the sensitivity is for |
| encounter | 0..1 | Reference(MR Encounter) | Encounter when the allergy or intolerance was asserted | |
| recordedDate | SC | 0..1 | dateTime | Date first version of the resource instance was recorded inv-mr-allergies-date-01: Date must be in YYYY-MM-DD'T'HH:MM:SS format |
| recorder | 0..1 | Reference(MR PractitionerRole | MR Practitioner | MR Patient) | Who recorded the sensitivity | |
| asserter | S | 0..1 | Reference(MR PractitionerRole | MR Practitioner | MR Patient) | Source of the information about the allergy |
| note | ||||
| text | S | 1..1 | markdown | The annotation - text content (as markdown) Max Length: 200 |
| reaction | 0..1 | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
| manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event |
| text | 0..1 | string | Plain text representation of the concept Max Length: 100 | |
| severity | S | 0..1 | code | mild | moderate | severe (of event as a whole) |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance | C | 0..* | AUBaseAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context 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 inv-mr-allergyintolerance-noknownallergy-reaction: AllergyIntolerance.reaction must exist unless code is 'No known allergy' | ||||
 id | Σ | 0..1 | id | Logical id of this artifact | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
 extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | SΣ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 | ?!SΣC | 0..1 | CodeableConcept | Medirecords supports only active status Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: active | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| verificationStatus | ?!SΣC | 0..1 | CodeableConcept | Medirecords supports only confirmed verificationStatus Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: confirmed | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| 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 | Medirecords supports only medication category Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||
| criticality | Σ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||
| code | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance  (preferred) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept Max Length: 300 | ||||
| patient | SΣ | 1..1 | Reference(MR Patient) | Who the sensitivity is for | ||||
| encounter | 0..1 | Reference(MR Encounter) | Encounter when the allergy or intolerance was asserted | |||||
 onset[x] | 0..1 | When allergy or intolerance was identified | ||||||
| onsetDateTime | dateTime | |||||||
| onsetAge | Age | |||||||
| onsetPeriod | Period | |||||||
| onsetRange | Range | |||||||
| onsetString | string | |||||||
| recordedDate | SC | 0..1 | dateTime | Date first version of the resource instance was recorded inv-mr-allergies-date-01: Date must be in YYYY-MM-DD'T'HH:MM:SS format | ||||
| recorder | 0..1 | Reference(MR PractitionerRole | MR Practitioner | MR Patient) | Who recorded the sensitivity | |||||
| asserter | SΣ | 0..1 | Reference(MR PractitionerRole | MR Practitioner | MR Patient) | Source of the information about the allergy | ||||
| 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 | SΣ | 1..1 | markdown | The annotation - text content (as markdown) Max Length: 200 | ||||
| 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 | ||||
| substance | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent (preferred) | |||||
| manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept Max Length: 100 | ||||
| description | 0..1 | string | Description of the event as a whole | |||||
| onset | 0..1 | dateTime | Date(/time) when manifestations showed | |||||
| severity | S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | ||||
| exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: Route of Administration (preferred) | |||||
| note | 0..* | Annotation | Text about event not captured in other fields | |||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | 0..* | AUBaseAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context | |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| clinicalStatus | ?!ΣC | 0..1 | CodeableConcept | Medirecords supports only active status Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: active | |
| verificationStatus | ?!ΣC | 0..1 | CodeableConcept | Medirecords supports only confirmed verificationStatus Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: confirmed | |
| code | Σ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (preferred) |
| patient | Σ | 1..1 | Reference(MR Patient) | Who the sensitivity is for |
| recordedDate | C | 0..1 | dateTime | Date first version of the resource instance was recorded inv-mr-allergies-date-01: Date must be in YYYY-MM-DD'T'HH:MM:SS format |
| asserter | Σ | 0..1 | Reference(MR PractitionerRole | MR Practitioner | MR Patient) | Source of the information about the allergy |
| note | 0..* | Annotation | Additional text not captured in other fields | |
| text | Σ | 1..1 | markdown | The annotation - text content (as markdown) Max Length: 200 |
| reaction | 0..1 | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
| manifestation | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred) | |
| severity | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | |
| Documentation for this format | ||||
This structure is derived from AUBaseAllergyIntolerance
Summary
Mandatory: 1 element (1 nested mandatory element)
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from AUBaseAllergyIntolerance
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| AllergyIntolerance | C | 0..* | AUBaseAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context inv-mr-allergyintolerance-noknownallergy-reaction: AllergyIntolerance.reaction must exist unless code is 'No known allergy' |
| meta | ||||
| lastUpdated | S | 0..1 | instant | When the resource version last changed |
| profile | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| clinicalStatus | S | 0..1 | CodeableConcept | Medirecords supports only active status Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: active | |
| verificationStatus | S | 0..1 | CodeableConcept | Medirecords supports only confirmed verificationStatus Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: confirmed | |
| category | 0..1 | code | Medirecords supports only medication category | |
| code | S | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance |
| text | 0..1 | string | Plain text representation of the concept Max Length: 300 | |
| patient | S | 1..1 | Reference(MR Patient) | Who the sensitivity is for |
| encounter | 0..1 | Reference(MR Encounter) | Encounter when the allergy or intolerance was asserted | |
| recordedDate | SC | 0..1 | dateTime | Date first version of the resource instance was recorded inv-mr-allergies-date-01: Date must be in YYYY-MM-DD'T'HH:MM:SS format |
| recorder | 0..1 | Reference(MR PractitionerRole | MR Practitioner | MR Patient) | Who recorded the sensitivity | |
| asserter | S | 0..1 | Reference(MR PractitionerRole | MR Practitioner | MR Patient) | Source of the information about the allergy |
| note | ||||
| text | S | 1..1 | markdown | The annotation - text content (as markdown) Max Length: 200 |
| reaction | 0..1 | BackboneElement | Adverse Reaction Events linked to exposure to substance | |
| manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event |
| text | 0..1 | string | Plain text representation of the concept Max Length: 100 | |
| severity | S | 0..1 | code | mild | moderate | severe (of event as a whole) |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| AllergyIntolerance | C | 0..* | AUBaseAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context 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 inv-mr-allergyintolerance-noknownallergy-reaction: AllergyIntolerance.reaction must exist unless code is 'No known allergy' | ||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | SΣ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 1..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 | ?!SΣC | 0..1 | CodeableConcept | Medirecords supports only active status Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: active | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| verificationStatus | ?!SΣC | 0..1 | CodeableConcept | Medirecords supports only confirmed verificationStatus Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/allergyintolerance-verification | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: confirmed | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| 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 | Medirecords supports only medication category Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||
| criticality | Σ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||
| code | SΣ | 1..1 | CodeableConcept | Code that identifies the allergy or intolerance Binding: Indicator of Hypersensitivity or Intolerance to Substance (preferred) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept Max Length: 300 | ||||
| patient | SΣ | 1..1 | Reference(MR Patient) | Who the sensitivity is for | ||||
| encounter | 0..1 | Reference(MR Encounter) | Encounter when the allergy or intolerance was asserted | |||||
| onset[x] | 0..1 | When allergy or intolerance was identified | ||||||
| onsetDateTime | dateTime | |||||||
| onsetAge | Age | |||||||
| onsetPeriod | Period | |||||||
| onsetRange | Range | |||||||
| onsetString | string | |||||||
| recordedDate | SC | 0..1 | dateTime | Date first version of the resource instance was recorded inv-mr-allergies-date-01: Date must be in YYYY-MM-DD'T'HH:MM:SS format | ||||
| recorder | 0..1 | Reference(MR PractitionerRole | MR Practitioner | MR Patient) | Who recorded the sensitivity | |||||
| asserter | SΣ | 0..1 | Reference(MR PractitionerRole | MR Practitioner | MR Patient) | Source of the information about the allergy | ||||
| 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 | SΣ | 1..1 | markdown | The annotation - text content (as markdown) Max Length: 200 | ||||
| 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 | ||||
| substance | 0..1 | CodeableConcept | Specific substance or pharmaceutical product considered to be responsible for event Binding: Adverse Reaction Agent (preferred) | |||||
| manifestation | S | 1..* | CodeableConcept | Clinical symptoms/signs associated with the Event Binding: Clinical Finding (preferred) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept Max Length: 100 | ||||
| description | 0..1 | string | Description of the event as a whole | |||||
| onset | 0..1 | dateTime | Date(/time) when manifestations showed | |||||
| severity | S | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | ||||
| exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: Route of Administration (preferred) | |||||
| note | 0..* | Annotation | Text about event not captured in other fields | |||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code | URI | |||
| AllergyIntolerance.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsfrom the FHIR Standard | ||||
| AllergyIntolerance.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| AllergyIntolerance.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| AllergyIntolerance.clinicalStatus | required | Pattern: activehttp://hl7.org/fhir/ValueSet/allergyintolerance-clinical|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.verificationStatus | required | Pattern: confirmedhttp://hl7.org/fhir/ValueSet/allergyintolerance-verification|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.type | required | AllergyIntoleranceTypehttp://hl7.org/fhir/ValueSet/allergy-intolerance-type|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.category | required | AllergyIntoleranceCategoryhttp://hl7.org/fhir/ValueSet/allergy-intolerance-category|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.criticality | required | AllergyIntoleranceCriticalityhttp://hl7.org/fhir/ValueSet/allergy-intolerance-criticality|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.code | preferred | IndicatorOfHypersensitivityOrIntoleranceToSubstance https://healthterminologies.gov.au/fhir/ValueSet/indicator-hypersensitivity-intolerance-to-substance-2 | ||||
| AllergyIntolerance.reaction.substance | preferred | AdverseReactionAgent https://healthterminologies.gov.au/fhir/ValueSet/adverse-reaction-agent-1 | ||||
| AllergyIntolerance.reaction.manifestation | preferred | ClinicalFinding https://healthterminologies.gov.au/fhir/ValueSet/clinical-finding-1 | ||||
| AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverityhttp://hl7.org/fhir/ValueSet/reaction-event-severity|4.0.1from the FHIR Standard | ||||
| AllergyIntolerance.reaction.exposureRoute | preferred | RouteOfAdministration https://healthterminologies.gov.au/fhir/ValueSet/route-of-administration-1 |
| 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() | |
| inv-mr-allergies-date-01 | error | AllergyIntolerance.recordedDate | Date must be in YYYY-MM-DD'T'HH:MM:SS format : ($this as dateTime).toString().matches('^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$') | |
| inv-mr-allergyintolerance-noknownallergy-reaction | error | AllergyIntolerance | AllergyIntolerance.reaction must exist unless code is 'No known allergy' : code.coding.where(system='http://snomed.info/sct' and code='716186003').exists() xor reaction.exists() |