FHIR Artifacts > Structure Definition: AllergyIntolerance Profile
Structure Definition: AllergyIntolerance Profile
Canonical URL:http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-AllergyIntolerance
Simplifier project page: AllergyIntolerance
Derived from: AllergyIntolerance (R4)
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work
Differential View
AllergyIntolerance | I | AllergyIntolerance | Element IdAllergyIntolerance AllergyIntolerance Profile Alternate namesAllergy, Intolerance, Adverse Reaction DefinitionThe AllergyIntolerance Profile is based upon the core FHIR AllergyIntolerance Resource 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.
| |
meta | S Σ | 1..1 | Meta | There are no (further) constraints on this element Element IdAllergyIntolerance.meta Metadata about the resource DefinitionThe 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.
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element IdAllergyIntolerance.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdAllergyIntolerance.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdAllergyIntolerance.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
|
profile | S Σ | 1..* | canonical(StructureDefinition) | Element IdAllergyIntolerance.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
|
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdAllergyIntolerance.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdAllergyIntolerance.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example)Constraints
|
identifier | S Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier External ids for this item DefinitionBusiness 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. Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers. 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.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
clinicalStatus | S Σ ?! I | 1..1 | CodeableConceptBinding | Element IdAllergyIntolerance.clinicalStatus active | inactive | resolved DefinitionThe clinical status of the allergy or intolerance. Refer to discussion if clincalStatus is missing data. The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. The clinical status of the allergy or intolerance. AllergyIntoleranceClinicalStatusCodes (required)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
verificationStatus | S Σ ?! I | 0..1 | CodeableConceptBinding | Element IdAllergyIntolerance.verificationStatus unconfirmed | confirmed | refuted | entered-in-error DefinitionAssertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. AllergyIntoleranceVerificationStatusCodes (required)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
type | S Σ | 0..1 | codeBinding | Element IdAllergyIntolerance.type allergy | intolerance - Underlying mechanism (if known) Alternate namesCategory, Class DefinitionIdentification of the underlying physiological mechanism for the reaction risk. 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. Identification of the underlying physiological mechanism for a Reaction Risk. AllergyIntoleranceType (required)Constraints
|
category | S Σ | 0..* | codeBinding | Element IdAllergyIntolerance.category food | medication | environment | biologic Alternate namesCategory, Type, Reaction Type, Class DefinitionCategory of the identified substance. 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. Category of an identified substance associated with allergies or intolerances. AllergyIntoleranceCategory (required)Constraints
|
criticality | S Σ | 0..1 | codeBinding | Element IdAllergyIntolerance.criticality low | high | unable-to-assess Alternate namesSeverity, Seriousness, Contra-indication, Risk DefinitionEstimate of the potential clinical harm, or seriousness, of the reaction to the identified substance. 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. Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. AllergyIntoleranceCriticality (required)Constraints
|
code | S Σ | 1..1 | CodeableConceptBinding | Element IdAllergyIntolerance.code Concept - reference to a terminology or just text Alternate namesCode DefinitionA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. 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. Type of the substance/product, allergy or intolerance condition. AllergyIntoleranceSubstanceConditionUvIps (required)Constraints
|
coding | S Σ | 0..* | Coding | Element IdAllergyIntolerance.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
codeAllergyCA | S Σ | 0..1 | CodingBinding | Element IdAllergyIntolerance.code.coding:codeAllergyCA Optional slice for code for allergy or intolerance from the SNOMED CT CA code set DefinitionCode for an allergy or intolerance statement that is selected from the SNOMED CT Canadian edition value set. Allows for alternative encodings within a code system, and translations to other code systems. 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. Codes for allergy or intolerance from the SNOMED CT GPS code set SubstanceAndPharmaceuticalBiologicProductCode (required)Constraints
|
absentOrUnknownAllergy | S Σ | 0..1 | CodingBinding | Element IdAllergyIntolerance.code.coding:absentOrUnknownAllergy Code for absent or unknown allergy DefinitionCode 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"). Allows for alternative encodings within a code system, and translations to other code systems. 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. negation/exclusion codes for reporting no known allergies or not available data. NoAllergiesInfoUvIps (required)Constraints
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.code.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
patient | S Σ I | 1..1 | Reference(Patient) | Element IdAllergyIntolerance.patient Who the sensitivity is for Alternate namesPatient DefinitionThe patient who has the allergy or intolerance. 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. Allowed aggregation: referenced Constraints
|
reference | S Σ I | 1..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.patient.reference Literal reference, Relative, internal or absolute URL DefinitionA 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. 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.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdAllergyIntolerance.patient.type Type the reference refers to (e.g. "Patient") DefinitionThe 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). 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. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdAllergyIntolerance.patient.identifier Logical reference, when literal reference is not known DefinitionAn 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. 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).
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.patient.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. 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.
|
encounter | I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element IdAllergyIntolerance.encounter Encounter when the allergy or intolerance was asserted DefinitionThe encounter when the allergy or intolerance was asserted. 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.
|
onset[x] | S | 0..1 | There are no (further) constraints on this element Element IdAllergyIntolerance.onset[x] When allergy or intolerance was identified DefinitionEstimated or actual date, date-time, or age when allergy or intolerance was identified.
| |
onsetDateTime | dateTime | There are no (further) constraints on this element Data Type | ||
onsetAge | Age | There are no (further) constraints on this element Data Type | ||
onsetPeriod | Period | There are no (further) constraints on this element Data Type | ||
onsetRange | Range | There are no (further) constraints on this element Data Type | ||
onsetString | string | There are no (further) constraints on this element Data Type | ||
recordedDate | S | 0..1 | dateTime | There are no (further) constraints on this element Element IdAllergyIntolerance.recordedDate Date first version of the resource instance was recorded DefinitionThe recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.
|
recorder | I | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | There are no (further) constraints on this element Element IdAllergyIntolerance.recorder Who recorded the sensitivity Alternate namesAuthor DefinitionIndividual who recorded the record and takes responsibility for its content. 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. Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Constraints
|
asserter | Σ I | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element IdAllergyIntolerance.asserter Source of the information about the allergy Alternate namesSource, Informant DefinitionThe source of the information about the allergy that is recorded. The recorder takes responsibility for the content, but can reference the source from where they got it. Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Constraints
|
lastOccurrence | S | 0..1 | dateTime | There are no (further) constraints on this element Element IdAllergyIntolerance.lastOccurrence Date(/time) of last known occurrence of a reaction DefinitionRepresents the date and/or time of the last known occurrence of a reaction event. 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.
|
note | S | 0..1 | Annotation | There are no (further) constraints on this element Element IdAllergyIntolerance.note Additional text not captured in other fields DefinitionAdditional narrative about the propensity for the Adverse Reaction, not captured in other fields. 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.
|
author[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdAllergyIntolerance.note.author[x] Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. Organization is used when there's no need for specific attribution as to who made the comment.
| |
authorString | string | There are no (further) constraints on this element Data Type | ||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Data Type Reference(Practitioner | Patient | RelatedPerson | Organization) | ||
time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element IdAllergyIntolerance.note.time When the annotation was made DefinitionIndicates when this particular annotation was made.
|
text | S Σ | 1..1 | markdown | There are no (further) constraints on this element Element IdAllergyIntolerance.note.text The annotation - text content (as markdown) DefinitionThe text of the annotation in markdown format. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
|
reaction | S | 0..* | BackboneElement | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction Adverse Reaction Events linked to exposure to substance DefinitionDetails about each adverse reaction event linked to exposure to the identified substance.
|
substance | S | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance Specific substance or pharmaceutical product considered to be responsible for event DefinitionIdentification 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. 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'. Codes defining the type of the substance (including pharmaceutical products). SubstanceCode (example)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
manifestation | S | 1..* | CodeableConcept | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation Clinical symptoms/signs associated with the Event Alternate namesSymptoms, Signs DefinitionClinical symptoms and/or signs that are observed or associated with the adverse reaction event. 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. Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event. SNOMEDCTClinicalFindings (example)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
description | S | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.description Description of the event as a whole Alternate namesNarrative, Text DefinitionText description about the reaction as a whole, including details of the manifestation if required. 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.
|
onset | S | 0..1 | dateTime | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.onset Date(/time) when manifestations showed DefinitionRecord of the date and/or time of the onset of the Reaction.
|
severity | S | 0..1 | codeBinding | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.severity mild | moderate | severe (of event as a whole) DefinitionClinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations. 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. Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. AllergyIntoleranceSeverity (required)Constraints
|
exposureRoute | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.exposureRoute How the subject was exposed to the substance DefinitionIdentification of the route by which the subject was exposed to the substance. Coding of the route of exposure with a terminology should be used wherever possible. A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. SNOMEDCTRouteCodes (example)Constraints
| |
note | S | 0..* | Annotation | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.note Text about event not captured in other fields DefinitionAdditional text about the adverse reaction event not captured in other fields. 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.
|
Hybrid View
AllergyIntolerance | I | AllergyIntolerance | Element IdAllergyIntolerance AllergyIntolerance Profile Alternate namesAllergy, Intolerance, Adverse Reaction DefinitionThe AllergyIntolerance Profile is based upon the core FHIR AllergyIntolerance Resource 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.
| |
meta | S Σ | 1..1 | Meta | There are no (further) constraints on this element Element IdAllergyIntolerance.meta Metadata about the resource DefinitionThe 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.
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element IdAllergyIntolerance.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdAllergyIntolerance.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdAllergyIntolerance.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
|
profile | S Σ | 1..* | canonical(StructureDefinition) | Element IdAllergyIntolerance.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
|
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdAllergyIntolerance.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdAllergyIntolerance.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example)Constraints
|
identifier | S Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier External ids for this item DefinitionBusiness 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. Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers. 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.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
clinicalStatus | S Σ ?! I | 1..1 | CodeableConceptBinding | Element IdAllergyIntolerance.clinicalStatus active | inactive | resolved DefinitionThe clinical status of the allergy or intolerance. Refer to discussion if clincalStatus is missing data. The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. The clinical status of the allergy or intolerance. AllergyIntoleranceClinicalStatusCodes (required)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
verificationStatus | S Σ ?! I | 0..1 | CodeableConceptBinding | Element IdAllergyIntolerance.verificationStatus unconfirmed | confirmed | refuted | entered-in-error DefinitionAssertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. AllergyIntoleranceVerificationStatusCodes (required)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
type | S Σ | 0..1 | codeBinding | Element IdAllergyIntolerance.type allergy | intolerance - Underlying mechanism (if known) Alternate namesCategory, Class DefinitionIdentification of the underlying physiological mechanism for the reaction risk. 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. Identification of the underlying physiological mechanism for a Reaction Risk. AllergyIntoleranceType (required)Constraints
|
category | S Σ | 0..* | codeBinding | Element IdAllergyIntolerance.category food | medication | environment | biologic Alternate namesCategory, Type, Reaction Type, Class DefinitionCategory of the identified substance. 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. Category of an identified substance associated with allergies or intolerances. AllergyIntoleranceCategory (required)Constraints
|
criticality | S Σ | 0..1 | codeBinding | Element IdAllergyIntolerance.criticality low | high | unable-to-assess Alternate namesSeverity, Seriousness, Contra-indication, Risk DefinitionEstimate of the potential clinical harm, or seriousness, of the reaction to the identified substance. 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. Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. AllergyIntoleranceCriticality (required)Constraints
|
code | S Σ | 1..1 | CodeableConceptBinding | Element IdAllergyIntolerance.code Concept - reference to a terminology or just text Alternate namesCode DefinitionA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. 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. Type of the substance/product, allergy or intolerance condition. AllergyIntoleranceSubstanceConditionUvIps (required)Constraints
|
coding | S Σ | 0..* | Coding | Element IdAllergyIntolerance.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
codeAllergyCA | S Σ | 0..1 | CodingBinding | Element IdAllergyIntolerance.code.coding:codeAllergyCA Optional slice for code for allergy or intolerance from the SNOMED CT CA code set DefinitionCode for an allergy or intolerance statement that is selected from the SNOMED CT Canadian edition value set. Allows for alternative encodings within a code system, and translations to other code systems. 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. Codes for allergy or intolerance from the SNOMED CT GPS code set SubstanceAndPharmaceuticalBiologicProductCode (required)Constraints
|
absentOrUnknownAllergy | S Σ | 0..1 | CodingBinding | Element IdAllergyIntolerance.code.coding:absentOrUnknownAllergy Code for absent or unknown allergy DefinitionCode 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"). Allows for alternative encodings within a code system, and translations to other code systems. 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. negation/exclusion codes for reporting no known allergies or not available data. NoAllergiesInfoUvIps (required)Constraints
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.code.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
patient | S Σ I | 1..1 | Reference(Patient) | Element IdAllergyIntolerance.patient Who the sensitivity is for Alternate namesPatient DefinitionThe patient who has the allergy or intolerance. 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. Allowed aggregation: referenced Constraints
|
reference | S Σ I | 1..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.patient.reference Literal reference, Relative, internal or absolute URL DefinitionA 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. 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.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdAllergyIntolerance.patient.type Type the reference refers to (e.g. "Patient") DefinitionThe 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). 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. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdAllergyIntolerance.patient.identifier Logical reference, when literal reference is not known DefinitionAn 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. 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).
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.patient.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. 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.
|
encounter | I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element IdAllergyIntolerance.encounter Encounter when the allergy or intolerance was asserted DefinitionThe encounter when the allergy or intolerance was asserted. 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.
|
onset[x] | S | 0..1 | There are no (further) constraints on this element Element IdAllergyIntolerance.onset[x] When allergy or intolerance was identified DefinitionEstimated or actual date, date-time, or age when allergy or intolerance was identified.
| |
onsetDateTime | dateTime | There are no (further) constraints on this element Data Type | ||
onsetAge | Age | There are no (further) constraints on this element Data Type | ||
onsetPeriod | Period | There are no (further) constraints on this element Data Type | ||
onsetRange | Range | There are no (further) constraints on this element Data Type | ||
onsetString | string | There are no (further) constraints on this element Data Type | ||
recordedDate | S | 0..1 | dateTime | There are no (further) constraints on this element Element IdAllergyIntolerance.recordedDate Date first version of the resource instance was recorded DefinitionThe recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.
|
recorder | I | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | There are no (further) constraints on this element Element IdAllergyIntolerance.recorder Who recorded the sensitivity Alternate namesAuthor DefinitionIndividual who recorded the record and takes responsibility for its content. 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. Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Constraints
|
asserter | Σ I | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element IdAllergyIntolerance.asserter Source of the information about the allergy Alternate namesSource, Informant DefinitionThe source of the information about the allergy that is recorded. The recorder takes responsibility for the content, but can reference the source from where they got it. Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Constraints
|
lastOccurrence | S | 0..1 | dateTime | There are no (further) constraints on this element Element IdAllergyIntolerance.lastOccurrence Date(/time) of last known occurrence of a reaction DefinitionRepresents the date and/or time of the last known occurrence of a reaction event. 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.
|
note | S | 0..1 | Annotation | There are no (further) constraints on this element Element IdAllergyIntolerance.note Additional text not captured in other fields DefinitionAdditional narrative about the propensity for the Adverse Reaction, not captured in other fields. 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.
|
author[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdAllergyIntolerance.note.author[x] Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. Organization is used when there's no need for specific attribution as to who made the comment.
| |
authorString | string | There are no (further) constraints on this element Data Type | ||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Data Type Reference(Practitioner | Patient | RelatedPerson | Organization) | ||
time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element IdAllergyIntolerance.note.time When the annotation was made DefinitionIndicates when this particular annotation was made.
|
text | S Σ | 1..1 | markdown | There are no (further) constraints on this element Element IdAllergyIntolerance.note.text The annotation - text content (as markdown) DefinitionThe text of the annotation in markdown format. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
|
reaction | S | 0..* | BackboneElement | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction Adverse Reaction Events linked to exposure to substance DefinitionDetails about each adverse reaction event linked to exposure to the identified substance.
|
substance | S | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance Specific substance or pharmaceutical product considered to be responsible for event DefinitionIdentification 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. 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'. Codes defining the type of the substance (including pharmaceutical products). SubstanceCode (example)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
manifestation | S | 1..* | CodeableConcept | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation Clinical symptoms/signs associated with the Event Alternate namesSymptoms, Signs DefinitionClinical symptoms and/or signs that are observed or associated with the adverse reaction event. 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. Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event. SNOMEDCTClinicalFindings (example)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
description | S | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.description Description of the event as a whole Alternate namesNarrative, Text DefinitionText description about the reaction as a whole, including details of the manifestation if required. 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.
|
onset | S | 0..1 | dateTime | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.onset Date(/time) when manifestations showed DefinitionRecord of the date and/or time of the onset of the Reaction.
|
severity | S | 0..1 | codeBinding | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.severity mild | moderate | severe (of event as a whole) DefinitionClinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations. 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. Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. AllergyIntoleranceSeverity (required)Constraints
|
exposureRoute | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.exposureRoute How the subject was exposed to the substance DefinitionIdentification of the route by which the subject was exposed to the substance. Coding of the route of exposure with a terminology should be used wherever possible. A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. SNOMEDCTRouteCodes (example)Constraints
| |
note | S | 0..* | Annotation | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.note Text about event not captured in other fields DefinitionAdditional text about the adverse reaction event not captured in other fields. 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.
|
Snapshot View
AllergyIntolerance | I | AllergyIntolerance | Element IdAllergyIntolerance AllergyIntolerance Profile Alternate namesAllergy, Intolerance, Adverse Reaction DefinitionThe AllergyIntolerance Profile is based upon the core FHIR AllergyIntolerance Resource 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.
| |
meta | S Σ | 1..1 | Meta | There are no (further) constraints on this element Element IdAllergyIntolerance.meta Metadata about the resource DefinitionThe 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.
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element IdAllergyIntolerance.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element IdAllergyIntolerance.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element IdAllergyIntolerance.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
|
profile | S Σ | 1..* | canonical(StructureDefinition) | Element IdAllergyIntolerance.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
|
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element IdAllergyIntolerance.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System. All Security Labels (extensible)Constraints
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element IdAllergyIntolerance.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". CommonTags (example)Constraints
|
identifier | S Σ | 0..* | Identifier | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier External ids for this item DefinitionBusiness 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. Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers. 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.
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . IdentifierUse (required)Constraints
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible)Constraints
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
assigner | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element IdAllergyIntolerance.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
|
clinicalStatus | S Σ ?! I | 1..1 | CodeableConceptBinding | Element IdAllergyIntolerance.clinicalStatus active | inactive | resolved DefinitionThe clinical status of the allergy or intolerance. Refer to discussion if clincalStatus is missing data. The data type is CodeableConcept because clinicalStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. The clinical status of the allergy or intolerance. AllergyIntoleranceClinicalStatusCodes (required)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.clinicalStatus.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
verificationStatus | S Σ ?! I | 0..1 | CodeableConceptBinding | Element IdAllergyIntolerance.verificationStatus unconfirmed | confirmed | refuted | entered-in-error DefinitionAssertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). The data type is CodeableConcept because verificationStatus has some clinical judgment involved, such that there might need to be more specificity than the required FHIR value set allows. For example, a SNOMED coding might allow for additional specificity. Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. AllergyIntoleranceVerificationStatusCodes (required)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.verificationStatus.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
type | S Σ | 0..1 | codeBinding | Element IdAllergyIntolerance.type allergy | intolerance - Underlying mechanism (if known) Alternate namesCategory, Class DefinitionIdentification of the underlying physiological mechanism for the reaction risk. 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. Identification of the underlying physiological mechanism for a Reaction Risk. AllergyIntoleranceType (required)Constraints
|
category | S Σ | 0..* | codeBinding | Element IdAllergyIntolerance.category food | medication | environment | biologic Alternate namesCategory, Type, Reaction Type, Class DefinitionCategory of the identified substance. 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. Category of an identified substance associated with allergies or intolerances. AllergyIntoleranceCategory (required)Constraints
|
criticality | S Σ | 0..1 | codeBinding | Element IdAllergyIntolerance.criticality low | high | unable-to-assess Alternate namesSeverity, Seriousness, Contra-indication, Risk DefinitionEstimate of the potential clinical harm, or seriousness, of the reaction to the identified substance. 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. Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. AllergyIntoleranceCriticality (required)Constraints
|
code | S Σ | 1..1 | CodeableConceptBinding | Element IdAllergyIntolerance.code Concept - reference to a terminology or just text Alternate namesCode DefinitionA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. 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. Type of the substance/product, allergy or intolerance condition. AllergyIntoleranceSubstanceConditionUvIps (required)Constraints
|
coding | S Σ | 0..* | Coding | Element IdAllergyIntolerance.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Unordered, Open, by $this(Pattern) Constraints
|
codeAllergyCA | S Σ | 0..1 | CodingBinding | Element IdAllergyIntolerance.code.coding:codeAllergyCA Optional slice for code for allergy or intolerance from the SNOMED CT CA code set DefinitionCode for an allergy or intolerance statement that is selected from the SNOMED CT Canadian edition value set. Allows for alternative encodings within a code system, and translations to other code systems. 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. Codes for allergy or intolerance from the SNOMED CT GPS code set SubstanceAndPharmaceuticalBiologicProductCode (required)Constraints
|
absentOrUnknownAllergy | S Σ | 0..1 | CodingBinding | Element IdAllergyIntolerance.code.coding:absentOrUnknownAllergy Code for absent or unknown allergy DefinitionCode 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"). Allows for alternative encodings within a code system, and translations to other code systems. 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. negation/exclusion codes for reporting no known allergies or not available data. NoAllergiesInfoUvIps (required)Constraints
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.code.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
patient | S Σ I | 1..1 | Reference(Patient) | Element IdAllergyIntolerance.patient Who the sensitivity is for Alternate namesPatient DefinitionThe patient who has the allergy or intolerance. 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. Allowed aggregation: referenced Constraints
|
reference | S Σ I | 1..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.patient.reference Literal reference, Relative, internal or absolute URL DefinitionA 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. 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.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element IdAllergyIntolerance.patient.type Type the reference refers to (e.g. "Patient") DefinitionThe 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). 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. Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible)Constraints
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element IdAllergyIntolerance.patient.identifier Logical reference, when literal reference is not known DefinitionAn 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. 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).
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.patient.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. 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.
|
encounter | I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element IdAllergyIntolerance.encounter Encounter when the allergy or intolerance was asserted DefinitionThe encounter when the allergy or intolerance was asserted. 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.
|
onset[x] | S | 0..1 | There are no (further) constraints on this element Element IdAllergyIntolerance.onset[x] When allergy or intolerance was identified DefinitionEstimated or actual date, date-time, or age when allergy or intolerance was identified.
| |
onsetDateTime | dateTime | There are no (further) constraints on this element Data Type | ||
onsetAge | Age | There are no (further) constraints on this element Data Type | ||
onsetPeriod | Period | There are no (further) constraints on this element Data Type | ||
onsetRange | Range | There are no (further) constraints on this element Data Type | ||
onsetString | string | There are no (further) constraints on this element Data Type | ||
recordedDate | S | 0..1 | dateTime | There are no (further) constraints on this element Element IdAllergyIntolerance.recordedDate Date first version of the resource instance was recorded DefinitionThe recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.
|
recorder | I | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | There are no (further) constraints on this element Element IdAllergyIntolerance.recorder Who recorded the sensitivity Alternate namesAuthor DefinitionIndividual who recorded the record and takes responsibility for its content. 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. Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Constraints
|
asserter | Σ I | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element IdAllergyIntolerance.asserter Source of the information about the allergy Alternate namesSource, Informant DefinitionThe source of the information about the allergy that is recorded. The recorder takes responsibility for the content, but can reference the source from where they got it. Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Constraints
|
lastOccurrence | S | 0..1 | dateTime | There are no (further) constraints on this element Element IdAllergyIntolerance.lastOccurrence Date(/time) of last known occurrence of a reaction DefinitionRepresents the date and/or time of the last known occurrence of a reaction event. 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.
|
note | S | 0..1 | Annotation | There are no (further) constraints on this element Element IdAllergyIntolerance.note Additional text not captured in other fields DefinitionAdditional narrative about the propensity for the Adverse Reaction, not captured in other fields. 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.
|
author[x] | Σ | 0..1 | There are no (further) constraints on this element Element IdAllergyIntolerance.note.author[x] Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. Organization is used when there's no need for specific attribution as to who made the comment.
| |
authorString | string | There are no (further) constraints on this element Data Type | ||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | There are no (further) constraints on this element Data Type Reference(Practitioner | Patient | RelatedPerson | Organization) | ||
time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element IdAllergyIntolerance.note.time When the annotation was made DefinitionIndicates when this particular annotation was made.
|
text | S Σ | 1..1 | markdown | There are no (further) constraints on this element Element IdAllergyIntolerance.note.text The annotation - text content (as markdown) DefinitionThe text of the annotation in markdown format. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
|
reaction | S | 0..* | BackboneElement | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction Adverse Reaction Events linked to exposure to substance DefinitionDetails about each adverse reaction event linked to exposure to the identified substance.
|
substance | S | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance Specific substance or pharmaceutical product considered to be responsible for event DefinitionIdentification 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. 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'. Codes defining the type of the substance (including pharmaceutical products). SubstanceCode (example)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.substance.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
manifestation | S | 1..* | CodeableConcept | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation Clinical symptoms/signs associated with the Event Alternate namesSymptoms, Signs DefinitionClinical symptoms and/or signs that are observed or associated with the adverse reaction event. 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. Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event. SNOMEDCTClinicalFindings (example)Constraints
|
coding | S Σ | 0..* | Coding | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. 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. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
system | S Σ | 0..1 | uri | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.coding.system Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.coding.version Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
code | S Σ | 0..1 | code | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.coding.code Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.coding.display Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
text | S Σ | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.manifestation.text Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings.
|
description | S | 0..1 | string | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.description Description of the event as a whole Alternate namesNarrative, Text DefinitionText description about the reaction as a whole, including details of the manifestation if required. 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.
|
onset | S | 0..1 | dateTime | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.onset Date(/time) when manifestations showed DefinitionRecord of the date and/or time of the onset of the Reaction.
|
severity | S | 0..1 | codeBinding | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.severity mild | moderate | severe (of event as a whole) DefinitionClinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations. 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. Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. AllergyIntoleranceSeverity (required)Constraints
|
exposureRoute | 0..1 | CodeableConcept | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.exposureRoute How the subject was exposed to the substance DefinitionIdentification of the route by which the subject was exposed to the substance. Coding of the route of exposure with a terminology should be used wherever possible. A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. SNOMEDCTRouteCodes (example)Constraints
| |
note | S | 0..* | Annotation | There are no (further) constraints on this element Element IdAllergyIntolerance.reaction.note Text about event not captured in other fields DefinitionAdditional text about the adverse reaction event not captured in other fields. 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.
|
Table View
AllergyIntolerance | .. | |
AllergyIntolerance.meta | 1.. | |
AllergyIntolerance.meta.profile | 1.. | |
AllergyIntolerance.identifier | .. | |
AllergyIntolerance.identifier.system | .. | |
AllergyIntolerance.identifier.value | .. | |
AllergyIntolerance.clinicalStatus | 1.. | |
AllergyIntolerance.clinicalStatus.coding | .. | |
AllergyIntolerance.clinicalStatus.coding.system | .. | |
AllergyIntolerance.clinicalStatus.coding.code | .. | |
AllergyIntolerance.clinicalStatus.coding.display | .. | |
AllergyIntolerance.verificationStatus | .. | |
AllergyIntolerance.verificationStatus.coding | .. | |
AllergyIntolerance.verificationStatus.coding.system | .. | |
AllergyIntolerance.verificationStatus.coding.code | .. | |
AllergyIntolerance.verificationStatus.coding.display | .. | |
AllergyIntolerance.type | .. | |
AllergyIntolerance.category | .. | |
AllergyIntolerance.criticality | .. | |
AllergyIntolerance.code | 1.. | |
AllergyIntolerance.code.coding | .. | |
AllergyIntolerance.code.coding | ..1 | |
AllergyIntolerance.code.coding | ..1 | |
AllergyIntolerance.code.text | .. | |
AllergyIntolerance.patient | Reference(Patient) | .. |
AllergyIntolerance.patient.reference | 1.. | |
AllergyIntolerance.onset[x] | .. | |
AllergyIntolerance.recordedDate | .. | |
AllergyIntolerance.lastOccurrence | .. | |
AllergyIntolerance.note | ..1 | |
AllergyIntolerance.note.text | .. | |
AllergyIntolerance.reaction | .. | |
AllergyIntolerance.reaction.substance | .. | |
AllergyIntolerance.reaction.substance.coding | .. | |
AllergyIntolerance.reaction.substance.coding.system | .. | |
AllergyIntolerance.reaction.substance.coding.code | .. | |
AllergyIntolerance.reaction.substance.text | .. | |
AllergyIntolerance.reaction.manifestation | .. | |
AllergyIntolerance.reaction.manifestation.coding | .. | |
AllergyIntolerance.reaction.manifestation.coding.system | .. | |
AllergyIntolerance.reaction.manifestation.coding.code | .. | |
AllergyIntolerance.reaction.manifestation.text | .. | |
AllergyIntolerance.reaction.description | .. | |
AllergyIntolerance.reaction.onset | .. | |
AllergyIntolerance.reaction.severity | .. | |
AllergyIntolerance.reaction.note | .. |
JSON View
{ "resourceType": "StructureDefinition", "id": "ca-on-eReferral-profile-AllergyIntolerance", "url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-AllergyIntolerance", "version": "1.0.0", "name": "EReferralAllergyIntolerance", "title": "AllergyIntolerance", "status": "draft", "description": "This profile details the clinical assessment of an allergy or intolerance; a propensity, or a potential risk to an individual, to have an adverse reaction on future exposure to the specified substance, or class of substance.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "AllergyIntolerance", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/AllergyIntolerance", "derivation": "constraint", "differential": { "element": [ { "id": "AllergyIntolerance", "path": "AllergyIntolerance", "short": "AllergyIntolerance Profile", "definition": "The AllergyIntolerance Profile is based upon the core FHIR AllergyIntolerance Resource" }, { "id": "AllergyIntolerance.meta", "path": "AllergyIntolerance.meta", "min": 1, "mustSupport": true }, { "id": "AllergyIntolerance.meta.profile", "path": "AllergyIntolerance.meta.profile", "comment": "#### **_` FOR eREFERRAL USAGE: The meta.profile = http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-AllergyIntolerance|1.0.0 `_**\n\nIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.", "min": 1, "mustSupport": true }, { "id": "AllergyIntolerance.identifier", "path": "AllergyIntolerance.identifier", "mustSupport": true }, { "id": "AllergyIntolerance.identifier.system", "path": "AllergyIntolerance.identifier.system", "mustSupport": true }, { "id": "AllergyIntolerance.identifier.value", "path": "AllergyIntolerance.identifier.value", "mustSupport": true }, { "id": "AllergyIntolerance.clinicalStatus", "path": "AllergyIntolerance.clinicalStatus", "min": 1, "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/allergyintolerance-clinical" } }, { "id": "AllergyIntolerance.clinicalStatus.coding", "path": "AllergyIntolerance.clinicalStatus.coding", "mustSupport": true }, { "id": "AllergyIntolerance.clinicalStatus.coding.system", "path": "AllergyIntolerance.clinicalStatus.coding.system", "mustSupport": true }, { "id": "AllergyIntolerance.clinicalStatus.coding.code", "path": "AllergyIntolerance.clinicalStatus.coding.code", "mustSupport": true }, { "id": "AllergyIntolerance.clinicalStatus.coding.display", "path": "AllergyIntolerance.clinicalStatus.coding.display", "mustSupport": true }, { "id": "AllergyIntolerance.verificationStatus", "path": "AllergyIntolerance.verificationStatus", "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/allergyintolerance-verification" } }, { "id": "AllergyIntolerance.verificationStatus.coding", "path": "AllergyIntolerance.verificationStatus.coding", "mustSupport": true }, { "id": "AllergyIntolerance.verificationStatus.coding.system", "path": "AllergyIntolerance.verificationStatus.coding.system", "mustSupport": true }, { "id": "AllergyIntolerance.verificationStatus.coding.code", "path": "AllergyIntolerance.verificationStatus.coding.code", "mustSupport": true }, { "id": "AllergyIntolerance.verificationStatus.coding.display", "path": "AllergyIntolerance.verificationStatus.coding.display", "mustSupport": true }, { "id": "AllergyIntolerance.type", "path": "AllergyIntolerance.type", "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/allergy-intolerance-type" } }, { "id": "AllergyIntolerance.category", "path": "AllergyIntolerance.category", "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/allergy-intolerance-category" } }, { "id": "AllergyIntolerance.criticality", "path": "AllergyIntolerance.criticality", "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality" } }, { "id": "AllergyIntolerance.code", "path": "AllergyIntolerance.code", "short": "Concept - reference to a terminology or just text", "definition": "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.", "comment": "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.", "min": 1, "mustSupport": true, "binding": { "strength": "required", "description": "Type of the substance/product, allergy or intolerance condition.", "valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/allergy-intolerance-substance-condition-uv-ips" } }, { "id": "AllergyIntolerance.code.coding", "path": "AllergyIntolerance.code.coding", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "rules": "open" }, "definition": "A reference to a code defined by a terminology system.", "mustSupport": true }, { "id": "AllergyIntolerance.code.coding:codeAllergyCA", "path": "AllergyIntolerance.code.coding", "sliceName": "codeAllergyCA", "short": "Optional slice for code for allergy or intolerance from the SNOMED CT CA code set", "definition": "Code for an allergy or intolerance statement that is selected from the SNOMED CT Canadian edition value set.", "comment": "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.", "max": "1", "mustSupport": true, "binding": { "strength": "required", "description": "Codes for allergy or intolerance from the SNOMED CT GPS code set", "valueSet": "http://fhir.infoway-inforoute.ca/io/psca/ValueSet/substanceandpharmaceuticalbiologicproductcode" } }, { "id": "AllergyIntolerance.code.coding:absentOrUnknownAllergy", "path": "AllergyIntolerance.code.coding", "sliceName": "absentOrUnknownAllergy", "short": "Code for absent or unknown allergy", "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\").", "comment": "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.", "max": "1", "mustSupport": true, "binding": { "strength": "required", "description": "negation/exclusion codes for reporting no known allergies or not available data.", "valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-allergies-uv-ips" } }, { "id": "AllergyIntolerance.code.text", "path": "AllergyIntolerance.code.text", "mustSupport": true }, { "id": "AllergyIntolerance.patient", "path": "AllergyIntolerance.patient", "type": [ { "code": "Reference", "targetProfile": [ "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Patient" ], "aggregation": [ "referenced" ] } ], "mustSupport": true }, { "id": "AllergyIntolerance.patient.reference", "path": "AllergyIntolerance.patient.reference", "min": 1, "mustSupport": true }, { "id": "AllergyIntolerance.onset[x]", "path": "AllergyIntolerance.onset[x]", "mustSupport": true }, { "id": "AllergyIntolerance.recordedDate", "path": "AllergyIntolerance.recordedDate", "mustSupport": true }, { "id": "AllergyIntolerance.lastOccurrence", "path": "AllergyIntolerance.lastOccurrence", "mustSupport": true }, { "id": "AllergyIntolerance.note", "path": "AllergyIntolerance.note", "max": "1", "mustSupport": true }, { "id": "AllergyIntolerance.note.text", "path": "AllergyIntolerance.note.text", "mustSupport": true }, { "id": "AllergyIntolerance.reaction", "path": "AllergyIntolerance.reaction", "mustSupport": true }, { "id": "AllergyIntolerance.reaction.substance", "path": "AllergyIntolerance.reaction.substance", "mustSupport": true }, { "id": "AllergyIntolerance.reaction.substance.coding", "path": "AllergyIntolerance.reaction.substance.coding", "mustSupport": true }, { "id": "AllergyIntolerance.reaction.substance.coding.system", "path": "AllergyIntolerance.reaction.substance.coding.system", "mustSupport": true }, { "id": "AllergyIntolerance.reaction.substance.coding.code", "path": "AllergyIntolerance.reaction.substance.coding.code", "mustSupport": true }, { "id": "AllergyIntolerance.reaction.substance.text", "path": "AllergyIntolerance.reaction.substance.text", "mustSupport": true }, { "id": "AllergyIntolerance.reaction.manifestation", "path": "AllergyIntolerance.reaction.manifestation", "mustSupport": true }, { "id": "AllergyIntolerance.reaction.manifestation.coding", "path": "AllergyIntolerance.reaction.manifestation.coding", "mustSupport": true }, { "id": "AllergyIntolerance.reaction.manifestation.coding.system", "path": "AllergyIntolerance.reaction.manifestation.coding.system", "mustSupport": true }, { "id": "AllergyIntolerance.reaction.manifestation.coding.code", "path": "AllergyIntolerance.reaction.manifestation.coding.code", "mustSupport": true }, { "id": "AllergyIntolerance.reaction.manifestation.text", "path": "AllergyIntolerance.reaction.manifestation.text", "mustSupport": true }, { "id": "AllergyIntolerance.reaction.description", "path": "AllergyIntolerance.reaction.description", "mustSupport": true }, { "id": "AllergyIntolerance.reaction.onset", "path": "AllergyIntolerance.reaction.onset", "mustSupport": true }, { "id": "AllergyIntolerance.reaction.severity", "path": "AllergyIntolerance.reaction.severity", "mustSupport": true }, { "id": "AllergyIntolerance.reaction.note", "path": "AllergyIntolerance.reaction.note", "mustSupport": true } ] } }
Usage
The AllergyIntolerance resource is used to attach supporting information to a ServiceRequest.
Notes
.id
- used to uniquely identify the resource
- if a persistent identity for the resource is not available to use when constructing a message Bundle for transmission via Direct Messaging, a UUID SHOULD be used in this element (with a corresponding value in
Bundle.entry.fullUrl
)
.meta.profile
- used to declare conformance to this profile
- populate with a fixed value:
http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-AllergyIntolerance|1.0.0