AllergiesAndAdverseReactions

CareConnect-DCH-AllergyIntolerance-1

CareConnect-DCH-AllergyIntolerance-1

AllergyIntolerance
Definition
Control 0..*
Comments
AllergyIntolerance.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control 0..1 ?
Type Id
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.

AllergyIntolerance.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control 0..1 ?
Type Meta
Comments
AllergyIntolerance.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control 0..1 ?
Type Uri
Is Modifier True
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.

AllergyIntolerance.language
Definition

The base language in which the resource is written.

Control 0..1 ?
Binding

A human language.

The codes SHALL be taken from http://tools.ietf.org/html/bcp47

Type Code
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

AllergyIntolerance.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control 0..1 ?
Type Narrative
Aliases narrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

AllergyIntolerance.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control 0..*
Type Resource
Aliases inline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

AllergyIntolerance.extension(encounter)
Definition
Control 0..1
Type Extension
Comments
AllergyIntolerance.extension(endDate)
Definition
Control 0..1
Type Extension
Comments
AllergyIntolerance.extension(evidence)
Definition
Control 0..1
Type Extension
Must Support True
Comments
AllergyIntolerance.extension(probabilityofRecurrence)
Definition
Control 0..1
Type Extension
Must Support True
Comments
AllergyIntolerance.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control 0..* ?
Type Extension
Is Modifier True
Aliases extensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AllergyIntolerance.identifier
Definition
Control 1..1
Comments
AllergyIntolerance.identifier.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

AllergyIntolerance.identifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control 0..* ?
Type Extension
Aliases extensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AllergyIntolerance.identifier.use
Definition

The purpose of this identifier.

Control 0..1 ?
Binding

Identifies the purpose for this identifier, if known .

The codes SHALL be taken from http://hl7.org/fhir/ValueSet/identifier-use

Type Code
Is Modifier True
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

AllergyIntolerance.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control 0..1 ?
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

The codes SHALL be taken from the following if appropriate, otherwise an alternate coding may be included instead. http://hl7.org/fhir/ValueSet/identifier-type

Type CodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

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.

AllergyIntolerance.identifier.type.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

AllergyIntolerance.identifier.type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control 0..* ?
Type Extension
Aliases extensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AllergyIntolerance.identifier.type.coding
Definition

A reference to a code defined by a terminology system.

Control 0..* ?
Type Coding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

AllergyIntolerance.identifier.type.coding.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

AllergyIntolerance.identifier.type.coding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control 0..* ?
Type Extension
Aliases extensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AllergyIntolerance.identifier.type.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control 0..1 ?
Type Uri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

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 de-reference to some definition that establish the system clearly and unambiguously.

AllergyIntolerance.identifier.type.coding.version
Definition

The 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.

Control 0..1 ?
Type String
Comments

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.

AllergyIntolerance.identifier.type.coding.code
Definition

A 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).

Control 0..1 ?
Type Code
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may not exceed 1MB in size

AllergyIntolerance.identifier.type.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control 0..1 ?
Type String
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings may not exceed 1MB in size

AllergyIntolerance.identifier.type.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control 0..1 ?
Type Boolean
Requirements

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.

Comments

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.

AllergyIntolerance.identifier.type.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control 0..1 ?
Type String
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

AllergyIntolerance.identifier.system
Definition
Control 1..*
Comments
AllergyIntolerance.identifier.value
Definition
Control 1..*
Comments
AllergyIntolerance.identifier.period
Definition

Time period during which identifier is/was valid for use.

Control 0..1 ?
Type Period
Comments

This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. 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"). If duration is required, specify the type as Interval|Duration.

AllergyIntolerance.identifier.period.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

AllergyIntolerance.identifier.period.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control 0..* ?
Type Extension
Aliases extensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AllergyIntolerance.identifier.period.start
Definition

The start of the period. The boundary is inclusive.

Control 0..1 ?
Type DateTime
Comments

If the low element is missing, the meaning is that the low boundary is not known.

AllergyIntolerance.identifier.period.end
Definition

The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Control 0..1 ?
Type DateTime
Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.

AllergyIntolerance.identifier.assigner
Definition
Control 0..*
Type https://fhir.nhs.uk/StructureDefinition/CareConnect-DCH-Organization-1
Comments
AllergyIntolerance.identifier.assigner.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

AllergyIntolerance.identifier.assigner.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control 0..* ?
Type Extension
Aliases extensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AllergyIntolerance.identifier.assigner.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control 0..1 ?
Type String
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

AllergyIntolerance.identifier.assigner.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control 0..1 ?
Type String
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

AllergyIntolerance.onset
Definition
Control 0..*
Must Support True
Comments
AllergyIntolerance.recordedDate
Definition
Control 1..*
Comments
AllergyIntolerance.recorder
Definition
Control 0..*
Type Choice of:
Comments
AllergyIntolerance.patient
Definition
Control 0..*
Type https://fhir.nhs.uk/StructureDefinition/CareConnect-DCH-Patient-1
Comments
AllergyIntolerance.patient.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

AllergyIntolerance.patient.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control 0..* ?
Type Extension
Aliases extensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AllergyIntolerance.patient.reference
Definition
Control 1..*
Comments
AllergyIntolerance.patient.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control 0..1 ?
Type String
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

AllergyIntolerance.reporter
Definition
Control 0..*
Type Choice of:
Comments
AllergyIntolerance.substance
Definition

Identification of a substance, or a class of substances, that is considered to be responsible for the adverse reaction risk.

Control 1..1 ?
Binding

Type of the substance and Negation codes for reporting no known allergies.

For example codes, see http://hl7.org/fhir/ValueSet/allergyintolerance-substance-code

; other codes may be used where these codes are not suitable
Type CodeableConcept
Aliases Agent
Comments

It is strongly recommended that the substance be coded with a terminology, where possible. For example, some terminologies used include RxNorm, SNOMED CT, DM+D, NDFRT, ICD-9, IDC-10, UNI, ATC and CPT. Plain text should only be used if there is no appropriate terminology available. Additional details about a substance can be specified in the text.

AllergyIntolerance.substance.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

AllergyIntolerance.substance.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control 0..* ?
Type Extension
Aliases extensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AllergyIntolerance.substance.coding(SNOMED CT)
Definition
Control 0..1
Comments
AllergyIntolerance.substance.coding.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

AllergyIntolerance.substance.coding.extension(snomedCTDescriptionID)
Definition
Control 0..*
Type Extension
Comments
AllergyIntolerance.substance.coding.system
Definition
Control 1..*
Comments
Fixed Value http://snomed.info/sct
AllergyIntolerance.substance.coding.code
Definition
Control 1..*
Comments
AllergyIntolerance.substance.coding.display
Definition
Control 1..*
Comments
AllergyIntolerance.substance.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control 0..1 ?
Type Boolean
Requirements

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.

Comments

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.

AllergyIntolerance.substance.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control 0..1 ?
Type String
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

AllergyIntolerance.status
Definition

Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified Substance.

Control 0..1 ?
Binding

Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified Substance.

The codes SHALL be taken from http://hl7.org/fhir/ValueSet/allergy-intolerance-status

Type Code
Is Modifier True
Aliases State
Comments

Decision support would typically raise alerts for 'Unconfirmed', 'Confirmed', and 'Resolved' and ignore a 'Refuted' reaction. In particular, 'Refuted' may be useful for reconciliation of the Adverse Reaction List. Some implementations may choose to make this field mandatory.

AllergyIntolerance.criticality
Definition

Estimate of the potential clinical harm, or seriousness, of the reaction to the identified Substance.

Control 0..1 ?
Binding

Estimate of the potential clinical harm, or seriousness, of a reaction to an identified Substance.

The codes SHALL be taken from http://hl7.org/fhir/ValueSet/allergy-intolerance-criticality

Type Code
Aliases Severity, Seriousness, Contra-indication, Risk
Comments

The default criticality value for any propensity to an adverse reaction should be 'Low Risk', indicating at the very least a relative contraindication to deliberate or voluntary exposure to the Substance. 'High Risk' is flagged if the clinician has identified a propensity for a more serious or potentially life-threatening reaction, such as anaphylaxis, and implies an absolute contraindication to deliberate or voluntary exposure to the substance. If this element is missing, the criticality is unknown (though it may be known elsewhere).

AllergyIntolerance.type
Definition
Control 0..*
Must Support True
Comments
AllergyIntolerance.category
Definition

Category of the identified Substance.

Control 0..1 ?
Binding

Category of an identified Substance.

The codes SHALL be taken from http://hl7.org/fhir/ValueSet/allergy-intolerance-category

Type Code
Aliases Category, Type, Reaction Type, Class
Comments

This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the Substance where coding systems are used, and is effectively redundant in that situation.

AllergyIntolerance.lastOccurence
Definition

Represents the date and/or time of the last known occurrence of a reaction event.

Control 0..1 ?
Type DateTime
Comments

This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.

AllergyIntolerance.note
Definition

Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.

Control 0..1 ?
Type Annotation
Comments

For example: including reason for flagging a seriousness of 'High Risk'; and instructions related to future exposure or administration of the Substance, such as administration within an Intensive Care Unit or under corticosteroid cover. The notes should be related to an allergy or intolerance as a condition in general and not related to any particular episode of it. For episode notes and descriptions, use AllergyIntolerance.event.description and AllergyIntolerance.event.notes.

AllergyIntolerance.note.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

AllergyIntolerance.note.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control 0..* ?
Type Extension
Aliases extensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AllergyIntolerance.note.author[x]
Definition
Control 0..*
Type Choice of:
Comments
AllergyIntolerance.note.time
Definition

Indicates when this particular annotation was made.

Control 0..1 ?
Type DateTime
Comments
AllergyIntolerance.note.text
Definition

The text of the annotation.

Control 1..1 ?
Type String
Comments

Note that FHIR strings may not exceed 1MB in size

AllergyIntolerance.reaction
Definition
Control 1..*
Comments
AllergyIntolerance.reaction.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

AllergyIntolerance.reaction.extension(allergyCertainty)
Definition
Control 0..1
Type Extension
Must Support True
Comments
AllergyIntolerance.reaction.extension(allergySeverity)
Definition
Control 1..1
Type Extension
Comments
AllergyIntolerance.reaction.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control 0..* ?
Type Extension
Is Modifier True
Aliases extensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AllergyIntolerance.reaction.substance
Definition
Control 1..*
Comments
AllergyIntolerance.reaction.substance.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

AllergyIntolerance.reaction.substance.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control 0..* ?
Type Extension
Aliases extensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AllergyIntolerance.reaction.substance.coding(SNOMED CT)
Definition
Control 0..1
Comments
AllergyIntolerance.reaction.substance.coding.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

AllergyIntolerance.reaction.substance.coding.extension(snomedCTDescriptionID)
Definition
Control 0..*
Type Extension
Comments
AllergyIntolerance.reaction.substance.coding.system
Definition
Control 1..*
Comments
Fixed Value http://snomed.info/sct
AllergyIntolerance.reaction.substance.coding.code
Definition
Control 1..*
Comments
AllergyIntolerance.reaction.substance.coding.display
Definition
Control 1..*
Comments
AllergyIntolerance.reaction.substance.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control 0..1 ?
Type Boolean
Requirements

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.

Comments

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.

AllergyIntolerance.reaction.substance.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control 0..1 ?
Type String
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

AllergyIntolerance.reaction.manifestation
Definition

Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.

Control 1..* ?
Binding

Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event.

For example codes, see http://hl7.org/fhir/ValueSet/manifestation-codes

; other codes may be used where these codes are not suitable
Type CodeableConcept
Aliases Symptoms, Signs
Comments

Manifestation can be expressed as a single word, phrase or brief description. For example: nausea, rash or no reaction. It is preferable that manifestation should be coded with a terminology, where possible. The values entered here may be used to display on an application screen as part of a list of adverse reactions, as recommended in the UK NHS CUI guidelines. Terminologies commonly used include, but are not limited to, SNOMED CT or ICD10.

AllergyIntolerance.reaction.manifestation.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

AllergyIntolerance.reaction.manifestation.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control 0..* ?
Type Extension
Aliases extensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AllergyIntolerance.reaction.manifestation.coding(SNOMED CT)
Definition
Control 0..1
Comments
AllergyIntolerance.reaction.manifestation.coding.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

AllergyIntolerance.reaction.manifestation.coding.extension(snomedCTDescriptionID)
Definition
Control 0..*
Type Extension
Comments
AllergyIntolerance.reaction.manifestation.coding.system
Definition
Control 1..*
Comments
Fixed Value http://snomed.info/sct
AllergyIntolerance.reaction.manifestation.coding.code
Definition
Control 1..*
Comments
AllergyIntolerance.reaction.manifestation.coding.display
Definition
Control 1..*
Comments
AllergyIntolerance.reaction.manifestation.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control 0..1 ?
Type Boolean
Requirements

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.

Comments

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.

AllergyIntolerance.reaction.manifestation.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control 0..1 ?
Type String
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

AllergyIntolerance.reaction.description
Definition
Control 0..*
Must Support True
Comments
AllergyIntolerance.reaction.onset
Definition

Record of the date and/or time of the onset of the Reaction.

Control 0..1 ?
Type DateTime
Comments
AllergyIntolerance.reaction.exposureRoute
Definition

Identification of the route by which the subject was exposed to the substance.

Control 0..1 ?
Binding

A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.

For example codes, see http://hl7.org/fhir/ValueSet/route-codes

; other codes may be used where these codes are not suitable
Type CodeableConcept
Comments

Coding of the route of exposure with a terminology should be used wherever possible.

AllergyIntolerance.reaction.exposureRoute.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

AllergyIntolerance.reaction.exposureRoute.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control 0..* ?
Type Extension
Aliases extensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AllergyIntolerance.reaction.exposureRoute.coding(SNOMED CT)
Definition
Control 0..1
Comments
AllergyIntolerance.reaction.exposureRoute.coding.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

AllergyIntolerance.reaction.exposureRoute.coding.extension(snomedCTDescriptionID)
Definition
Control 0..*
Type Extension
Comments
AllergyIntolerance.reaction.exposureRoute.coding.system
Definition
Control 1..*
Comments
Fixed Value http://snomed.info/sct
AllergyIntolerance.reaction.exposureRoute.coding.code
Definition
Control 1..*
Comments
AllergyIntolerance.reaction.exposureRoute.coding.display
Definition
Control 1..*
Comments
AllergyIntolerance.reaction.exposureRoute.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control 0..1 ?
Type Boolean
Requirements

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.

Comments

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.

AllergyIntolerance.reaction.exposureRoute.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control 0..1 ?
Type String
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

AllergyIntolerance.reaction.note
Definition

Additional text about the adverse reaction event not captured in other fields.

Control 0..1 ?
Type Annotation
Comments

Use this field to record information indirectly related to a particular event and not captured in the description. For example: Clinical records are no longer available, recorded based on information provided to the patient by her mother and her mother is deceased.

AllergyIntolerance.reaction.note.id
Definition

unique id for the element within a resource (for internal references).

Control 0..1 ?
Type Id
Comments

RFC 4122

AllergyIntolerance.reaction.note.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control 0..* ?
Type Extension
Aliases extensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AllergyIntolerance.reaction.note.author[x]
Definition
Control 0..*
Type Choice of:
Comments
AllergyIntolerance.reaction.note.time
Definition

Indicates when this particular annotation was made.

Control 0..1 ?
Type DateTime
Comments
AllergyIntolerance.reaction.note.text
Definition

The text of the annotation.

Control 1..1 ?
Type String
Comments

Note that FHIR strings may not exceed 1MB in size