AllergyIntolerance
Allergy Intolerance / Warnings / Notes
- Data sources: Health Professional, PMS, MedicAlert Provider Portal, MedicAlert Fhir API
-profile to be updated
- the are additional options for Types, so you may need to AllowUnrecognizedEnums in your client: Allergy, Intolerance, Warning, (e.g on medication, etc) NoteOnly (just a note from the GP)
Differential View
AllergyIntoleranceUvIps (AllergyIntolerance) | S I | AllergyIntolerance | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
abatement-datetime | S I | 0..1 | Extension(dateTime) |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
clinicalStatus | S Σ ?! I | 0..1 | Codeable Concept (IPS)Binding |
verificationStatus | S Σ ?! I | 0..1 | Codeable Concept (IPS)Binding |
type | S Σ | 0..1 | codeBinding |
category | Σ | 0..* | codeBinding |
criticality | S Σ | 0..1 | codeBinding |
code | S Σ | 0..1 | Codeable Concept (IPS)Binding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..* | Coding with translations |
allergyIntoleranceGPSCode | S Σ | 0..* | Coding with translationsBinding |
absentOrUnknownAllergyIntolerance | S Σ | 0..1 | Coding with translationsBinding |
text | S Σ | 0..1 | string |
patient | S Σ I | 1..1 | Reference(Patient (IPS2)) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | S Σ I | 1..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
display | Σ | 0..1 | string |
encounter | I | 0..1 | Reference(Encounter) |
onset[x] | 0..1 | ||
(All Slices) | |||
onsetAge | Age | ||
onsetPeriod | Period | ||
onsetRange | Range | ||
onsetString | string | ||
onsetDateTime | S | 0..1 | dateTime |
recordedDate | 0..1 | dateTime | |
recorder | I | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) |
asserter | S Σ I | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) |
lastOccurrence | 0..1 | dateTime | |
note | 0..* | Annotation | |
reaction | S | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
substance | 0..1 | CodeableConcept | |
manifestation | S | 1..* | Codeable Concept (IPS) |
allergyIntoleranceReactionManifestationGPSCode | S | 0..1 | CodeableConceptBinding |
description | 0..1 | string | |
onset | S | 0..1 | dateTime |
severity | S | 0..1 | codeBinding |
exposureRoute | 0..1 | CodeableConcept | |
note | 0..* | Annotation |
Hybrid View
AllergyIntoleranceUvIps (AllergyIntolerance) | S I | AllergyIntolerance | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
abatement-datetime | S I | 0..1 | Extension(dateTime) |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
clinicalStatus | S Σ ?! I | 0..1 | Codeable Concept (IPS)Binding |
verificationStatus | S Σ ?! I | 0..1 | Codeable Concept (IPS)Binding |
type | S Σ | 0..1 | codeBinding |
category | Σ | 0..* | codeBinding |
criticality | S Σ | 0..1 | codeBinding |
code | S Σ | 0..1 | Codeable Concept (IPS)Binding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..* | Coding with translations |
allergyIntoleranceGPSCode | S Σ | 0..* | Coding with translationsBinding |
absentOrUnknownAllergyIntolerance | S Σ | 0..1 | Coding with translationsBinding |
text | S Σ | 0..1 | string |
patient | S Σ I | 1..1 | Reference(Patient (IPS2)) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | S Σ I | 1..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
display | Σ | 0..1 | string |
encounter | I | 0..1 | Reference(Encounter) |
onset[x] | 0..1 | ||
(All Slices) | |||
onsetAge | Age | ||
onsetPeriod | Period | ||
onsetRange | Range | ||
onsetString | string | ||
onsetDateTime | S | 0..1 | dateTime |
recordedDate | 0..1 | dateTime | |
recorder | I | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) |
asserter | S Σ I | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) |
lastOccurrence | 0..1 | dateTime | |
note | 0..* | Annotation | |
reaction | S | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
substance | 0..1 | CodeableConcept | |
manifestation | S | 1..* | Codeable Concept (IPS) |
allergyIntoleranceReactionManifestationGPSCode | S | 0..1 | CodeableConceptBinding |
description | 0..1 | string | |
onset | S | 0..1 | dateTime |
severity | S | 0..1 | codeBinding |
exposureRoute | 0..1 | CodeableConcept | |
note | 0..* | Annotation |
Snapshot View
AllergyIntoleranceUvIps (AllergyIntolerance) | S I | AllergyIntolerance | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
abatement-datetime | S I | 0..1 | Extension(dateTime) |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
clinicalStatus | S Σ ?! I | 0..1 | Codeable Concept (IPS)Binding |
verificationStatus | S Σ ?! I | 0..1 | Codeable Concept (IPS)Binding |
type | S Σ | 0..1 | codeBinding |
category | Σ | 0..* | codeBinding |
criticality | S Σ | 0..1 | codeBinding |
code | S Σ | 0..1 | Codeable Concept (IPS)Binding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | S Σ | 0..* | Coding with translations |
allergyIntoleranceGPSCode | S Σ | 0..* | Coding with translationsBinding |
absentOrUnknownAllergyIntolerance | S Σ | 0..1 | Coding with translationsBinding |
text | S Σ | 0..1 | string |
patient | S Σ I | 1..1 | Reference(Patient (IPS2)) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | S Σ I | 1..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
display | Σ | 0..1 | string |
encounter | I | 0..1 | Reference(Encounter) |
onset[x] | 0..1 | ||
(All Slices) | |||
onsetAge | Age | ||
onsetPeriod | Period | ||
onsetRange | Range | ||
onsetString | string | ||
onsetDateTime | S | 0..1 | dateTime |
recordedDate | 0..1 | dateTime | |
recorder | I | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) |
asserter | S Σ I | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) |
lastOccurrence | 0..1 | dateTime | |
note | 0..* | Annotation | |
reaction | S | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
substance | 0..1 | CodeableConcept | |
manifestation | S | 1..* | Codeable Concept (IPS) |
allergyIntoleranceReactionManifestationGPSCode | S | 0..1 | CodeableConceptBinding |
description | 0..1 | string | |
onset | S | 0..1 | dateTime |
severity | S | 0..1 | codeBinding |
exposureRoute | 0..1 | CodeableConcept | |
note | 0..* | Annotation |
Examples
Detailed descriptions
AllergyIntolerance | |
Definition | Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance. |
Cardinality | 0...* |
Must Support | True |
Alias | Allergy, Intolerance, Adverse Reaction |
Comments | Substances include, but are not limited to: a therapeutic substance administered correctly at an appropriate dosage for the individual; food; material derived from plants or animals; or venom from insect stings. |
Invariants |
|
Mappings |
|
AllergyIntolerance.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
AllergyIntolerance.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
AllergyIntolerance.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
AllergyIntolerance.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
AllergyIntolerance.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
AllergyIntolerance.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
AllergyIntolerance.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AllergyIntolerance.extension:abatement-datetime | |
Definition | The date or estimated date that the condition resolved or went into remission. |
Cardinality | 0...1 |
Type | Extension(dateTime) |
Must Support | True |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
AllergyIntolerance.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AllergyIntolerance.identifier | |
Definition | Business identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Requirements | Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers. |
Comments | This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. |
Invariants |
|
Mappings |
|
AllergyIntolerance.clinicalStatus | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Cardinality | 0...1 |
Type | Codeable Concept (IPS) |
Binding | The clinical status of the allergy or intolerance. |
Must Support | True |
Modifier | True |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
AllergyIntolerance.verificationStatus | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Cardinality | 0...1 |
Type | Codeable Concept (IPS) |
Binding | Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
Must Support | True |
Modifier | True |
Summary | True |
Comments | In the scope of the IPS the entered-in-error concept is not allowed. |
Invariants |
|
Mappings |
|
AllergyIntolerance.type | |
Definition | Identification of the underlying physiological mechanism for the reaction risk. |
Cardinality | 0...1 |
Type | code |
Binding | Identification of the underlying physiological mechanism for a Reaction Risk. |
Must Support | True |
Summary | True |
Alias | Category, Class |
Comments | Allergic (typically immune-mediated) reactions have been traditionally regarded as an indicator for potential escalation to significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune-mediated are, in fact, non-immune, but in some cases can still pose a life threatening risk. It is acknowledged that many clinicians might not be in a position to distinguish the mechanism of a particular reaction. Often the term "allergy" is used rather generically and may overlap with the use of "intolerance" - in practice the boundaries between these two concepts might not be well-defined or understood. This data element is included nevertheless, because many legacy systems have captured this attribute. Immunologic testing may provide supporting evidence for the basis of the reaction and the causative substance, but no tests are 100% sensitive or specific for sensitivity to a particular substance. If, as is commonly the case, it is unclear whether the reaction is due to an allergy or an intolerance, then the type element should be omitted from the resource. |
Invariants |
|
Mappings |
|
AllergyIntolerance.category | |
Definition | Category of the identified substance. |
Cardinality | 0...* |
Type | code |
Binding | Category of an identified substance associated with allergies or intolerances. |
Summary | True |
Alias | Category, Type, Reaction Type, Class |
Comments | This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the substance where coding systems are used, and is effectively redundant in that situation. When searching on category, consider the implications of AllergyIntolerance resources without a category. For example, when searching on category = medication, medication allergies that don't have a category valued will not be returned. Refer to search for more information on how to search category with a :missing modifier to get allergies that don't have a category. Additionally, category should be used with caution because category can be subjective based on the sender. |
Invariants |
|
Mappings |
|
AllergyIntolerance.criticality | |
Definition | Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance. |
Cardinality | 0...1 |
Type | code |
Binding | Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. |
Must Support | True |
Summary | True |
Alias | Severity, Seriousness, Contra-indication, Risk |
Comments | The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere). Systems that capture a severity at the condition level are actually representing the concept of criticality whereas the severity documented at the reaction level is representing the true reaction severity. Existing systems that are capturing both condition criticality and reaction severity may use the term "severity" to represent both. Criticality is the worst it could be in the future (i.e. situation-agnostic) whereas severity is situation-dependent. |
Invariants |
|
Mappings |
|
AllergyIntolerance.code | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Cardinality | 0...1 |
Type | Codeable Concept (IPS) |
Binding | Type of the substance/product, allergy or intolerance condition. |
Must Support | True |
Summary | True |
Alias | Code |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
AllergyIntolerance.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
AllergyIntolerance.code.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AllergyIntolerance.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding with translations |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
AllergyIntolerance.code.coding:allergyIntoleranceGPSCode | |
Definition | Code for an allergy or intolerance statement that is selected from the SNOMED CT GPS code set. |
Cardinality | 0...* |
Type | Coding with translations |
Binding | Codes for allergy or intolerance from the SNOMED CT GPS code set |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
Invariants |
|
Mappings |
|
AllergyIntolerance.code.coding:absentOrUnknownAllergyIntolerance | |
Definition | Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This describes a categorical negated statement (e.g., "No known allergy"). |
Cardinality | 0...1 |
Type | Coding with translations |
Binding | negation/exclusion codes for reporting no known allergies or not available data. |
Must Support | True |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
Invariants |
|
Mappings |
|
AllergyIntolerance.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Must Support | True |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | The text should be at the displayName level and not on this level. |
Invariants |
|
Mappings |
|
AllergyIntolerance.patient | |
Definition | The patient who has the allergy or intolerance. |
Cardinality | 1...1 |
Type | Reference(Patient (IPS2)) |
Must Support | True |
Summary | True |
Alias | Patient |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
AllergyIntolerance.patient.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
AllergyIntolerance.patient.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AllergyIntolerance.patient.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 1...1 |
Type | string |
Must Support | True |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
AllergyIntolerance.patient.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
AllergyIntolerance.patient.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
AllergyIntolerance.patient.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
AllergyIntolerance.encounter | |
Definition | The encounter when the allergy or intolerance was asserted. |
Cardinality | 0...1 |
Type | Reference(Encounter) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
AllergyIntolerance.onset[x] | |
Definition | Estimated or actual date, date-time, or age when allergy or intolerance was identified. |
Cardinality | 0...1 |
Type | dateTime |
Slicing | Unordered, Open, by $this(Type) |
Invariants |
|
Mappings |
|
AllergyIntolerance.onset[x]:onsetDateTime | |
Definition | Estimated or actual date, date-time, or age when allergy or intolerance was identified. |
Cardinality | 0...1 |
Type | dateTime |
Must Support | True |
Invariants |
|
Mappings |
|
AllergyIntolerance.recordedDate | |
Definition | The recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
AllergyIntolerance.recorder | |
Definition | Individual who recorded the record and takes responsibility for its content. |
Cardinality | 0...1 |
Type | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) |
Alias | Author |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
AllergyIntolerance.asserter | |
Definition | The source of the information about the allergy that is recorded. |
Cardinality | 0...1 |
Type | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) |
Must Support | True |
Summary | True |
Alias | Source, Informant |
Comments | The recorder takes responsibility for the content, but can reference the source from where they got it. |
Invariants |
|
Mappings |
|
AllergyIntolerance.lastOccurrence | |
Definition | Represents the date and/or time of the last known occurrence of a reaction event. |
Cardinality | 0...1 |
Type | dateTime |
Comments | This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used. |
Invariants |
|
Mappings |
|
AllergyIntolerance.note | |
Definition | Additional narrative about the propensity for the Adverse Reaction, not captured in other fields. |
Cardinality | 0...* |
Type | Annotation |
Comments | For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes. |
Invariants |
|
Mappings |
|
AllergyIntolerance.reaction | |
Definition | Details about each adverse reaction event linked to exposure to the identified substance. |
Cardinality | 0...* |
Type | BackboneElement |
Must Support | True |
Invariants |
|
Mappings |
|
AllergyIntolerance.reaction.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
AllergyIntolerance.reaction.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
AllergyIntolerance.reaction.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
AllergyIntolerance.reaction.substance | |
Definition | Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes defining the type of the substance (including pharmaceutical products). |
Comments | Coding of the specific substance (or pharmaceutical product) with a terminology capable of triggering decision support should be used wherever possible. The 'code' element allows for the use of a specific substance or pharmaceutical product, or a group or class of substances. In the case of an allergy or intolerance to a class of substances, (for example, "penicillins"), the 'reaction.substance' element could be used to code the specific substance that was identified as having caused the reaction (for example, "amoxycillin"). Duplication of the value in the 'code' and 'reaction.substance' elements is acceptable when a specific substance has been recorded in 'code'. |
Invariants |
|
Mappings |
|
AllergyIntolerance.reaction.manifestation | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Cardinality | 1...* |
Type | Codeable Concept (IPS) |
Binding | Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event. |
Must Support | True |
Alias | Symptoms, Signs |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Slicing | Unordered, Open, by $this(Pattern) |
Invariants |
|
Mappings |
|
AllergyIntolerance.reaction.manifestation:allergyIntoleranceReactionManifestationGPSCode | |
Definition | Code for an allergy or intolerance reaction manifestation statement that is selected from the SNOMED CT GPS code set. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event. |
Must Support | True |
Alias | Symptoms, Signs |
Comments | Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines. Terminologies commonly used include, but are not limited to, SNOMED CT or ICD10. |
Invariants |
|
Mappings |
|
AllergyIntolerance.reaction.description | |
Definition | Text description about the reaction as a whole, including details of the manifestation if required. |
Cardinality | 0...1 |
Type | string |
Alias | Narrative, Text |
Comments | Use the description to provide any details of a particular event of the occurred reaction such as circumstances, reaction specifics, what happened before/after. Information, related to the event, but not describing a particular care should be captured in the comment field. For example: at the age of four, the patient was given penicillin for strep throat and subsequently developed severe hives. |
Invariants |
|
Mappings |
|
AllergyIntolerance.reaction.onset | |
Definition | Record of the date and/or time of the onset of the Reaction. |
Cardinality | 0...1 |
Type | dateTime |
Must Support | True |
Invariants |
|
Mappings |
|
AllergyIntolerance.reaction.severity | |
Definition | Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations. |
Cardinality | 0...1 |
Type | code |
Binding | Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. |
Must Support | True |
Comments | It is acknowledged that this assessment is very subjective. There may be some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions. |
Invariants |
|
Mappings |
|
AllergyIntolerance.reaction.exposureRoute | |
Definition | Identification of the route by which the subject was exposed to the substance. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. |
Comments | Coding of the route of exposure with a terminology should be used wherever possible. |
Invariants |
|
Mappings |
|
AllergyIntolerance.reaction.note | |
Definition | Additional text about the adverse reaction event not captured in other fields. |
Cardinality | 0...* |
Type | Annotation |
Comments | Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased. |
Invariants |
|
Mappings |
|