Allergies and Intolerances
This section documents the relevant allergies or intolerances (conditions) for a patient, describing the kind of reaction (e.g. rash, anaphylaxis,..); preferably the agents that cause it; and optionally the criticality and the certainty of the allergy. At a minimum, it should list currently active and any relevant historical allergies and adverse reactions. If no information about allergies is available, or if no allergies are known this should be clearly documented in the section.
Allergy Intolerance
Tree view
AllergyIntolerance-uv-ips (AllergyIntolerance) | http://hl7.org/fhir/StructureDefinition/AllergyIntolerance | There are no (further) constraints on this element Data type http://hl7.org/fhir/StructureDefinition/AllergyIntolerance | ||
clinicalStatus | S | 1.. | There are no (further) constraints on this element Element idAllergyIntolerance.clinicalStatus | |
verificationStatus | S | There are no (further) constraints on this element Element idAllergyIntolerance.verificationStatus In the scope of the IPS the entered-in-error concept is not allowed. | ||
type | S | There are no (further) constraints on this element Element idAllergyIntolerance.type | ||
criticality | S | There are no (further) constraints on this element Element idAllergyIntolerance.criticality | ||
code | S | 1.. | There are no (further) constraints on this element Element idAllergyIntolerance.code Unordered, Closed, by coding.system(Value) | |
absentOrUnknownAllergy | ..1 | Codeable ConceptBinding | There are no (further) constraints on this element Element idAllergyIntolerance.code:absentOrUnknownAllergy Code for absent or unknown allergy or intolerance 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"). negation/exclusion codes for reporting no known allergies or not available data. IPSNoAllergiesInfo (required) | |
coding | 1..1 | There are no (further) constraints on this element Element idAllergyIntolerance.code:absentOrUnknownAllergy.coding | ||
system | 1.. | Fixed Value | There are no (further) constraints on this element Element idAllergyIntolerance.code:absentOrUnknownAllergy.coding.system http://hl7.org/fhir/ips/CodeSystem/absent-unknown | |
code | 1.. | There are no (further) constraints on this element Element idAllergyIntolerance.code:absentOrUnknownAllergy.coding.code | ||
@default | ..1 | Codeable ConceptBinding | There are no (further) constraints on this element Element idAllergyIntolerance.code:@default Code for an allergy or intolerance statement . This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"). Type of the substance/product, allergy or intolerance condition. Allergyintolerancesubstancecondition (preferred) | |
patient | S | There are no (further) constraints on this element Element idAllergyIntolerance.patient | ||
identifier | ..0 | There are no (further) constraints on this element Element idAllergyIntolerance.patient.identifier | ||
onsetDateTime | S | 1.. | dateTime | There are no (further) constraints on this element Element idAllergyIntolerance.onsetDateTime:onsetDateTime dateTime |
recorder | There are no (further) constraints on this element | |||
identifier | ..0 | There are no (further) constraints on this element Element idAllergyIntolerance.recorder.identifier | ||
asserter | There are no (further) constraints on this element | |||
identifier | ..0 | There are no (further) constraints on this element Element idAllergyIntolerance.asserter.identifier | ||
reaction | There are no (further) constraints on this element | |||
manifestation | S | Codeable ConceptBinding | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.manifestation ?? (preferred) | |
severity | S | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.severity |
AllergyIntolerance.clinicalStatus | |
Cardinality | 1 |
Must Support | True |
AllergyIntolerance.verificationStatus | |
Must Support | True |
Comments | In the scope of the IPS the entered-in-error concept is not allowed. |
AllergyIntolerance.type | |
Must Support | True |
AllergyIntolerance.criticality | |
Must Support | True |
AllergyIntolerance.code | |
Cardinality | 1 |
Must Support | True |
Slicing | Unordered, Closed, by coding.system(Value) |
AllergyIntolerance.code:absentOrUnknownAllergy | |
Definition | Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This describes a categorical negated statement (e.g., "No known allergy"). |
Cardinality | ...1 |
Type | Codeable Concept |
Binding | negation/exclusion codes for reporting no known allergies or not available data. IPSNoAllergiesInfo (required) |
AllergyIntolerance.code:absentOrUnknownAllergy.coding | |
Cardinality | 1...1 |
AllergyIntolerance.code:absentOrUnknownAllergy.coding.system | |
Cardinality | 1 |
Fixed Value | http://hl7.org/fhir/ips/CodeSystem/absent-unknown |
AllergyIntolerance.code:absentOrUnknownAllergy.coding.code | |
Cardinality | 1 |
AllergyIntolerance.code:@default | |
Definition | Code for an allergy or intolerance statement . This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"). |
Cardinality | ...1 |
Type | Codeable Concept |
Binding | Type of the substance/product, allergy or intolerance condition. Allergyintolerancesubstancecondition (preferred) |
AllergyIntolerance.patient | |
Must Support | True |
AllergyIntolerance.patient.identifier | |
Cardinality | ...0 |
AllergyIntolerance.onsetDateTime:onsetDateTime | |
Cardinality | 1 |
Type | dateTime |
Must Support | True |
AllergyIntolerance.recorder.identifier | |
Cardinality | ...0 |
AllergyIntolerance.asserter.identifier | |
Cardinality | ...0 |
AllergyIntolerance.reaction.manifestation | |
Type | Codeable Concept |
Binding | ?? (preferred) |
Must Support | True |
AllergyIntolerance.reaction.severity | |
Must Support | True |
AllergyIntolerance | 0..* | |
AllergyIntolerance.id | id | 0..1 |
AllergyIntolerance.meta | Meta | 0..1 |
AllergyIntolerance.implicitRules | uri | 0..1 |
AllergyIntolerance.language | code | 0..1 |
AllergyIntolerance.text | Narrative | 0..1 |
AllergyIntolerance.contained | Resource | 0..* |
AllergyIntolerance.extension | Extension | 0..* |
AllergyIntolerance.modifierExtension | Extension | 0..* |
AllergyIntolerance.identifier | Identifier | 0..* |
AllergyIntolerance.identifier.id | string | 0..1 |
AllergyIntolerance.identifier.extension | Extension | 0..* |
AllergyIntolerance.identifier.use | code | 0..1 |
AllergyIntolerance.identifier.type | CodeableConcept | 0..1 |
AllergyIntolerance.identifier.type.id | string | 0..1 |
AllergyIntolerance.identifier.type.extension | Extension | 0..* |
AllergyIntolerance.identifier.type.coding | Coding | 0..* |
AllergyIntolerance.identifier.type.coding.id | string | 0..1 |
AllergyIntolerance.identifier.type.coding.extension | Extension | 0..* |
AllergyIntolerance.identifier.type.coding.system | uri | 0..1 |
AllergyIntolerance.identifier.type.coding.version | string | 0..1 |
AllergyIntolerance.identifier.type.coding.code | code | 0..1 |
AllergyIntolerance.identifier.type.coding.display | string | 0..1 |
AllergyIntolerance.identifier.type.coding.userSelected | boolean | 0..1 |
AllergyIntolerance.identifier.type.text | string | 0..1 |
AllergyIntolerance.identifier.system | uri | 0..1 |
AllergyIntolerance.identifier.value | string | 0..1 |
AllergyIntolerance.identifier.period | Period | 0..1 |
AllergyIntolerance.identifier.period.id | string | 0..1 |
AllergyIntolerance.identifier.period.extension | Extension | 0..* |
AllergyIntolerance.identifier.period.start | dateTime | 0..1 |
AllergyIntolerance.identifier.period.end | dateTime | 0..1 |
AllergyIntolerance.identifier.assigner | Reference(http://hl7.org/fhir/StructureDefinition/Organization) | 0..1 |
AllergyIntolerance.identifier.assigner.id | string | 0..1 |
AllergyIntolerance.identifier.assigner.extension | Extension | 0..* |
AllergyIntolerance.identifier.assigner.reference | string | 0..1 |
AllergyIntolerance.identifier.assigner.identifier | Identifier | 0..1 |
AllergyIntolerance.identifier.assigner.display | string | 0..1 |
AllergyIntolerance.clinicalStatus | code | 1..1 |
AllergyIntolerance.verificationStatus | code | 1..1 |
AllergyIntolerance.type | code | 0..1 |
AllergyIntolerance.category | code | 0..* |
AllergyIntolerance.criticality | code | 0..1 |
AllergyIntolerance.code | CodeableConcept | 1..1 |
AllergyIntolerance.code.id | string | 0..1 |
AllergyIntolerance.code.extension | Extension | 0..* |
AllergyIntolerance.code.coding | Coding | 0..* |
AllergyIntolerance.code.coding.id | string | 0..1 |
AllergyIntolerance.code.coding.extension | Extension | 0..* |
AllergyIntolerance.code.coding.system | uri | 0..1 |
AllergyIntolerance.code.coding.version | string | 0..1 |
AllergyIntolerance.code.coding.code | code | 0..1 |
AllergyIntolerance.code.coding.display | string | 0..1 |
AllergyIntolerance.code.coding.userSelected | boolean | 0..1 |
AllergyIntolerance.code.text | string | 0..1 |
AllergyIntolerance.code | Codeable Concept | 0..1 |
AllergyIntolerance.code.id | string | 0..1 |
AllergyIntolerance.code.extension | Extension | 0..* |
AllergyIntolerance.code.coding | coding with translations | 1..1 |
AllergyIntolerance.code.coding.id | string | 0..1 |
AllergyIntolerance.code.coding.extension | Extension | 0..* |
AllergyIntolerance.code.coding.system | uri | 1..1 |
AllergyIntolerance.code.coding.version | string | 0..1 |
AllergyIntolerance.code.coding.code | code | 1..1 |
AllergyIntolerance.code.coding.display | string | 0..1 |
AllergyIntolerance.code.coding.display.id | string | 0..1 |
AllergyIntolerance.code.coding.display.extension | Extension | 0..* |
AllergyIntolerance.code.coding.display.extension | Extension | 0..* |
AllergyIntolerance.code.coding.display.value | 0..1 | |
AllergyIntolerance.code.coding.userSelected | boolean | 0..1 |
AllergyIntolerance.code.text | string | 0..1 |
AllergyIntolerance.code | Codeable Concept | 0..1 |
AllergyIntolerance.code.id | string | 0..1 |
AllergyIntolerance.code.extension | Extension | 0..* |
AllergyIntolerance.code.coding | Coding | 0..* |
AllergyIntolerance.code.coding.id | string | 0..1 |
AllergyIntolerance.code.coding.extension | Extension | 0..* |
AllergyIntolerance.code.coding.system | uri | 0..1 |
AllergyIntolerance.code.coding.version | string | 0..1 |
AllergyIntolerance.code.coding.code | code | 0..1 |
AllergyIntolerance.code.coding.display | string | 0..1 |
AllergyIntolerance.code.coding.userSelected | boolean | 0..1 |
AllergyIntolerance.code.text | string | 0..1 |
AllergyIntolerance.patient | Reference(http://hl7.org/fhir/StructureDefinition/Patient) | 1..1 |
AllergyIntolerance.patient.id | string | 0..1 |
AllergyIntolerance.patient.extension | Extension | 0..* |
AllergyIntolerance.patient.reference | string | 0..1 |
AllergyIntolerance.patient.identifier | Identifier | 0..0 |
AllergyIntolerance.patient.display | string | 0..1 |
AllergyIntolerance.onsetDateTime | dateTime | 1..1 |
AllergyIntolerance.assertedDate | dateTime | 0..1 |
AllergyIntolerance.recorder | Reference(http://hl7.org/fhir/StructureDefinition/Practitioner | http://hl7.org/fhir/StructureDefinition/Patient) | 0..1 |
AllergyIntolerance.recorder.id | string | 0..1 |
AllergyIntolerance.recorder.extension | Extension | 0..* |
AllergyIntolerance.recorder.reference | string | 0..1 |
AllergyIntolerance.recorder.identifier | Identifier | 0..0 |
AllergyIntolerance.recorder.display | string | 0..1 |
AllergyIntolerance.asserter | Reference(http://hl7.org/fhir/StructureDefinition/Patient | http://hl7.org/fhir/StructureDefinition/RelatedPerson | http://hl7.org/fhir/StructureDefinition/Practitioner) | 0..1 |
AllergyIntolerance.asserter.id | string | 0..1 |
AllergyIntolerance.asserter.extension | Extension | 0..* |
AllergyIntolerance.asserter.reference | string | 0..1 |
AllergyIntolerance.asserter.identifier | Identifier | 0..0 |
AllergyIntolerance.asserter.display | string | 0..1 |
AllergyIntolerance.lastOccurrence | dateTime | 0..1 |
AllergyIntolerance.note | Annotation | 0..* |
AllergyIntolerance.note.id | string | 0..1 |
AllergyIntolerance.note.extension | Extension | 0..* |
AllergyIntolerance.note.author[x] | Reference(http://hl7.org/fhir/StructureDefinition/Practitioner | http://hl7.org/fhir/StructureDefinition/Patient | http://hl7.org/fhir/StructureDefinition/RelatedPerson), string | 0..1 |
AllergyIntolerance.note.time | dateTime | 0..1 |
AllergyIntolerance.note.text | string | 1..1 |
AllergyIntolerance.reaction | BackboneElement | 0..* |
AllergyIntolerance.reaction.id | string | 0..1 |
AllergyIntolerance.reaction.extension | Extension | 0..* |
AllergyIntolerance.reaction.modifierExtension | Extension | 0..* |
AllergyIntolerance.reaction.substance | CodeableConcept | 0..1 |
AllergyIntolerance.reaction.substance.id | string | 0..1 |
AllergyIntolerance.reaction.substance.extension | Extension | 0..* |
AllergyIntolerance.reaction.substance.coding | Coding | 0..* |
AllergyIntolerance.reaction.substance.coding.id | string | 0..1 |
AllergyIntolerance.reaction.substance.coding.extension | Extension | 0..* |
AllergyIntolerance.reaction.substance.coding.system | uri | 0..1 |
AllergyIntolerance.reaction.substance.coding.version | string | 0..1 |
AllergyIntolerance.reaction.substance.coding.code | code | 0..1 |
AllergyIntolerance.reaction.substance.coding.display | string | 0..1 |
AllergyIntolerance.reaction.substance.coding.userSelected | boolean | 0..1 |
AllergyIntolerance.reaction.substance.text | string | 0..1 |
AllergyIntolerance.reaction.manifestation | Codeable Concept | 0..* |
AllergyIntolerance.reaction.manifestation.id | string | 0..1 |
AllergyIntolerance.reaction.manifestation.extension | Extension | 0..* |
AllergyIntolerance.reaction.manifestation.coding | Coding | 0..* |
AllergyIntolerance.reaction.manifestation.coding.id | string | 0..1 |
AllergyIntolerance.reaction.manifestation.coding.extension | Extension | 0..* |
AllergyIntolerance.reaction.manifestation.coding.system | uri | 0..1 |
AllergyIntolerance.reaction.manifestation.coding.version | string | 0..1 |
AllergyIntolerance.reaction.manifestation.coding.code | code | 0..1 |
AllergyIntolerance.reaction.manifestation.coding.display | string | 0..1 |
AllergyIntolerance.reaction.manifestation.coding.userSelected | boolean | 0..1 |
AllergyIntolerance.reaction.manifestation.text | string | 0..1 |
AllergyIntolerance.reaction.description | string | 0..1 |
AllergyIntolerance.reaction.onset | dateTime | 0..1 |
AllergyIntolerance.reaction.severity | code | 0..1 |
AllergyIntolerance.reaction.exposureRoute | CodeableConcept | 0..1 |
AllergyIntolerance.reaction.exposureRoute.id | string | 0..1 |
AllergyIntolerance.reaction.exposureRoute.extension | Extension | 0..* |
AllergyIntolerance.reaction.exposureRoute.coding | Coding | 0..* |
AllergyIntolerance.reaction.exposureRoute.coding.id | string | 0..1 |
AllergyIntolerance.reaction.exposureRoute.coding.extension | Extension | 0..* |
AllergyIntolerance.reaction.exposureRoute.coding.system | uri | 0..1 |
AllergyIntolerance.reaction.exposureRoute.coding.version | string | 0..1 |
AllergyIntolerance.reaction.exposureRoute.coding.code | code | 0..1 |
AllergyIntolerance.reaction.exposureRoute.coding.display | string | 0..1 |
AllergyIntolerance.reaction.exposureRoute.coding.userSelected | boolean | 0..1 |
AllergyIntolerance.reaction.exposureRoute.text | string | 0..1 |
AllergyIntolerance.reaction.note | Annotation | 0..* |
AllergyIntolerance.reaction.note.id | string | 0..1 |
AllergyIntolerance.reaction.note.extension | Extension | 0..* |
AllergyIntolerance.reaction.note.author[x] | Reference(http://hl7.org/fhir/StructureDefinition/Practitioner | http://hl7.org/fhir/StructureDefinition/Patient | http://hl7.org/fhir/StructureDefinition/RelatedPerson), string | 0..1 |
AllergyIntolerance.reaction.note.time | dateTime | 0..1 |
AllergyIntolerance.reaction.note.text | string | 1..1 |
AllergyIntolerance-uv-ips (AllergyIntolerance) | I | http://hl7.org/fhir/StructureDefinition/AllergyIntolerance | There are no (further) constraints on this element Element idAllergyIntolerance Allergy or Intolerance (generally: Risk of adverse reaction to a substance) Alternate namesAllergy, Intolerance, Adverse Reaction DefinitionRisk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance. 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. http://hl7.org/fhir/StructureDefinition/AllergyIntolerance Constraints
| |
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idAllergyIntolerance.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. id Constraints
|
meta | Σ | 0..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 may not always be associated with version changes to the resource. Meta Constraints
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idAllergyIntolerance.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. uri Constraints
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idAllergyIntolerance.language Language of the resource content DefinitionThe base language in which the resource is written. 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). code BindingA human language. Common Languages (extensible)Constraints
| |
text | I | 0..1 | Narrative | There are no (further) constraints on this element Element idAllergyIntolerance.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. Narrative Constraints
|
contained | 0..* | Resource | There are no (further) constraints on this element Element idAllergyIntolerance.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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. Resource Mappings
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idAllergyIntolerance.identifier External ids for this item DefinitionThis records identifiers associated with this allergy/intolerance concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). Identifier Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.use usual | official | temp | secondary (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. 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. code BindingIdentifies the purpose for this identifier, if known . ?? (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. CodeableConcept BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ?? (extensible)Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.type.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.type.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.type.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.type.coding.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.type.coding.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.type.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 de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.type.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. string Constraints
|
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.type.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 may not exceed 1MB in size code Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.type.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 may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.type.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. 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. boolean Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.type.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. string Constraints
|
system | Σ | 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. see http://en.wikipedia.org/wiki/Uniform_resource_identifier uri Constraints
General http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri Mappings
|
value | Σ | 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. string Constraints
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. 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. Period Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.period.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.period.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
start | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.period.start Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. dateTime Constraints
|
end | Σ I | 0..1 | dateTime | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.period.end End time with inclusive boundary, if not ongoing DefinitionThe 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. 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. If the end of the period is missing, it means that the period is ongoing dateTime Constraints
|
assigner | Σ I | 0..1 | Reference(http://hl7.org/fhir/StructureDefinition/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. Reference(http://hl7.org/fhir/StructureDefinition/Organization) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.assigner.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.assigner.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.assigner.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. string Constraints
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.assigner.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. Identifier Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.identifier.assigner.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. string Constraints
|
clinicalStatus | S Σ ?! I | 1..1 | codeBinding | There are no (further) constraints on this element Element idAllergyIntolerance.clinicalStatus active | inactive | resolved DefinitionThe clinical status of the allergy or intolerance. This element is labeled as a modifier because the status contains the codes inactive and resolved that mark the AllergyIntolerance as not currently valid. code BindingThe clinical status of the allergy or intolerance. ?? (required)Constraints
|
verificationStatus | S Σ ?! I | 1..1 | codeBinding | There are no (further) constraints on this element 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). In the scope of the IPS the entered-in-error concept is not allowed. code BindingAssertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. ?? (required)Constraints
|
type | S Σ | 0..1 | codeBinding | There are no (further) constraints on this element 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 may 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 may 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. code BindingIdentification of the underlying physiological mechanism for a Reaction Risk. ?? (required)Constraints
|
category | Σ | 0..* | codeBinding | There are no (further) constraints on this element 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. code BindingCategory of an identified substance. ?? (required)Constraints
|
criticality | S Σ | 0..1 | codeBinding | There are no (further) constraints on this element 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. code BindingEstimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. ?? (required)Constraints
|
code | S Σ | 1..1 | CodeableConcept | There are no (further) constraints on this element Element idAllergyIntolerance.code Code that identifies the allergy or intolerance Alternate namesCode DefinitionCode for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"), or a negated/excluded code for a specific substance or class (e.g., "No latex allergy") or a general or categorical negated statement (e.g., "No known allergy", "No known drug allergies"). It is strongly recommended that this element be populated using 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 can be specified in the text. When a substance or product code is specified for the 'code' element, the "default" semantic context is that this is a positive statement of an allergy or intolerance (depending on the value of the 'type' element, if present) condition to the specified substance/product. In the corresponding SNOMED CT allergy model, the specified substance/product is the target (destination) of the "Causative agent" relationship. The 'substanceExposureRisk' extension is available as a structured and more flexible alternative to the 'code' element for making positive or negative allergy or intolerance statements. This extension provides the capability to make "no known allergy" (or "no risk of adverse reaction") statements regarding any coded substance/product (including cases when a pre-coordinated "no allergy to x" concept for that substance/product does not exist). If the 'substanceExposureRisk' extension is present, the AllergyIntolerance.code element SHALL be omitted. CodeableConcept Sliced:Unordered, Closed, by coding.system(Value) BindingType of the substance/product, allergy or intolerance condition, or negation/exclusion codes for reporting no known allergies. ?? (example)Constraints
|
(All Slices) | There are no (further) constraints on this element | |||
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.code.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.code.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idAllergyIntolerance.code.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.code.coding.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.code.coding.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idAllergyIntolerance.code.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 de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.code.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. string Constraints
|
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idAllergyIntolerance.code.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 may not exceed 1MB in size code Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.code.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 may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idAllergyIntolerance.code.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. 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. boolean Constraints
|
text | Σ | 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. string Constraints
|
absentOrUnknownAllergy | Σ | 0..1 | Codeable ConceptBinding | There are no (further) constraints on this element Element idAllergyIntolerance.code:absentOrUnknownAllergy Code for absent or unknown allergy or intolerance Alternate namesCode 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"). 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. IPSNoAllergiesInfo (required)Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.code:absentOrUnknownAllergy.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.code:absentOrUnknownAllergy.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..1 | coding with translations | There are no (further) constraints on this element Element idAllergyIntolerance.code:absentOrUnknownAllergy.coding A reference to a code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.code:absentOrUnknownAllergy.coding.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.code:absentOrUnknownAllergy.coding.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idAllergyIntolerance.code:absentOrUnknownAllergy.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 de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
http://hl7.org/fhir/ips/CodeSystem/absent-unknown
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.code:absentOrUnknownAllergy.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. string Constraints
|
code | Σ | 1..1 | code | There are no (further) constraints on this element Element idAllergyIntolerance.code:absentOrUnknownAllergy.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 may not exceed 1MB in size code Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.code:absentOrUnknownAllergy.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 may not exceed 1MB in size string Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.code:absentOrUnknownAllergy.coding.display.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.code:absentOrUnknownAllergy.coding.display.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
translation | I | 0..* | Extension(Complex) | There are no (further) constraints on this element Element idAllergyIntolerance.code:absentOrUnknownAllergy.coding.display.extension:translation Language Translation (Localization) Alternate namesextensions, user content DefinitionLanguage translation from base language of resource to another language. 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. Extension(Complex) Extension URLhttp://hl7.org/fhir/StructureDefinition/translation Constraints
|
value | 0..1 | There are no (further) constraints on this element Element idAllergyIntolerance.code:absentOrUnknownAllergy.coding.display.value Primitive value for string DefinitionPrimitive value for string 1048576 | ||
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idAllergyIntolerance.code:absentOrUnknownAllergy.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. 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. boolean Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.code:absentOrUnknownAllergy.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. string Constraints
|
@default | Σ | 0..1 | Codeable ConceptBinding | There are no (further) constraints on this element Element idAllergyIntolerance.code:@default Concept - reference to a terminology or just text Alternate namesCode DefinitionCode for an allergy or intolerance statement . This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., "Latex"), an allergy or intolerance condition (e.g., "Latex allergy"). 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. Allergyintolerancesubstancecondition (preferred)Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.code:@default.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.code:@default.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idAllergyIntolerance.code:@default.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.code:@default.coding.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.code:@default.coding.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idAllergyIntolerance.code:@default.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 de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.code:@default.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. string Constraints
|
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idAllergyIntolerance.code:@default.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 may not exceed 1MB in size code Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.code:@default.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 may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idAllergyIntolerance.code:@default.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. 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. boolean Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.code:@default.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. string Constraints
|
patient | S Σ I | 1..1 | Reference(http://hl7.org/fhir/StructureDefinition/Patient) | There are no (further) constraints on this element 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. Reference(http://hl7.org/fhir/StructureDefinition/Patient) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.patient.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.patient.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | Σ I | 0..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. string Constraints
|
identifier | Σ | 0..0 | 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 other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. Identifier Constraints
|
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. string Constraints
|
onsetDateTime | S | 1..1 | dateTime | There are no (further) constraints on this element Element idAllergyIntolerance.onsetDateTime:onsetDateTime When allergy or intolerance was identified DefinitionEstimated or actual date, date-time, or age when allergy or intolerance was identified. dateTime Constraints
|
assertedDate | 0..1 | dateTime | There are no (further) constraints on this element Element idAllergyIntolerance.assertedDate Date record was believed accurate DefinitionThe date on which the existance of the AllergyIntolerance was first asserted or acknowledged. dateTime Constraints
| |
recorder | I | 0..1 | Reference(http://hl7.org/fhir/StructureDefinition/Practitioner | http://hl7.org/fhir/StructureDefinition/Patient) | 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(http://hl7.org/fhir/StructureDefinition/Practitioner | http://hl7.org/fhir/StructureDefinition/Patient) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.recorder.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.recorder.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.recorder.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. string Constraints
|
identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element idAllergyIntolerance.recorder.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. Identifier Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.recorder.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. string Constraints
|
asserter | Σ I | 0..1 | Reference(http://hl7.org/fhir/StructureDefinition/Patient | http://hl7.org/fhir/StructureDefinition/RelatedPerson | http://hl7.org/fhir/StructureDefinition/Practitioner) | 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 repsonsibility for the content, but can reference the source from where they got it. Reference(http://hl7.org/fhir/StructureDefinition/Patient | http://hl7.org/fhir/StructureDefinition/RelatedPerson | http://hl7.org/fhir/StructureDefinition/Practitioner) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.asserter.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.asserter.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | Σ I | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.asserter.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. string Constraints
|
identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element idAllergyIntolerance.asserter.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. Identifier Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.asserter.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. string Constraints
|
lastOccurrence | 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. dateTime Constraints
| |
note | 0..* | 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. Annotation Constraints
| |
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.note.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.note.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
author[x] | Σ I | 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. 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.
| |
authorString | string | There are no (further) constraints on this element Data type string | ||
authorReference | Reference(http://hl7.org/fhir/StructureDefinition/Practitioner | http://hl7.org/fhir/StructureDefinition/Patient | http://hl7.org/fhir/StructureDefinition/RelatedPerson) | There are no (further) constraints on this element Data type Reference(http://hl7.org/fhir/StructureDefinition/Practitioner | http://hl7.org/fhir/StructureDefinition/Patient | http://hl7.org/fhir/StructureDefinition/RelatedPerson) | ||
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. dateTime Constraints
|
text | 1..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.note.text The annotation - text content DefinitionThe text of the annotation. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
reaction | 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. BackboneElement Constraints
| |
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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. 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. Extension Constraints
|
substance | 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'. 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 identifed 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'. CodeableConcept BindingCodes defining the type of the substance (including pharmaceutical products). ?? (example)Constraints
| |
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.substance.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.substance.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 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 translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.substance.coding.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.substance.coding.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 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 de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
|
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. string Constraints
|
code | Σ | 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 may not exceed 1MB in size code Constraints
|
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 may not exceed 1MB in size string Constraints
|
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 - i.e. 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. boolean Constraints
|
text | Σ | 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. string Constraints
|
manifestation | S | 0..* | Codeable ConceptBinding | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.manifestation Concept - reference to a terminology or just text Alternate namesSymptoms, Signs 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. Clinical symptoms and/or signs that are observed or associated with an Adverse Reaction Event. ?? (preferred)Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.manifestation.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.manifestation.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 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 translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.manifestation.coding.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.manifestation.coding.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 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 de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
|
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. string Constraints
|
code | Σ | 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 may not exceed 1MB in size code Constraints
|
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 may not exceed 1MB in size string Constraints
|
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 - i.e. 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. boolean Constraints
|
text | Σ | 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. string Constraints
|
description | 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. string Constraints
| |
onset | 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. dateTime Constraints
| |
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 some specific practice domains where objective scales have been applied. Objective scales can be included in this model as extensions. code BindingClinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. ?? (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. CodeableConcept BindingA coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. ?? (example)Constraints
| |
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.exposureRoute.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.exposureRoute.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.exposureRoute.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Coding Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.exposureRoute.coding.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.exposureRoute.coding.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.exposureRoute.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 de-reference to some definition that establish the system clearly and unambiguously. uri Constraints
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.exposureRoute.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. string Constraints
|
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.exposureRoute.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 may not exceed 1MB in size code Constraints
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.exposureRoute.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 may not exceed 1MB in size string Constraints
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.exposureRoute.coding.userSelected If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. 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. boolean Constraints
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.exposureRoute.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. string Constraints
|
note | 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. Annotation Constraints
| |
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.note.id xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size string Constraints
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.note.extension Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Extension Sliced:Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
author[x] | Σ I | 0..1 | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.note.author[x] Individual responsible for the annotation DefinitionThe individual responsible for making the annotation. 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.
| |
authorString | string | There are no (further) constraints on this element Data type string | ||
authorReference | Reference(http://hl7.org/fhir/StructureDefinition/Practitioner | http://hl7.org/fhir/StructureDefinition/Patient | http://hl7.org/fhir/StructureDefinition/RelatedPerson) | There are no (further) constraints on this element Data type Reference(http://hl7.org/fhir/StructureDefinition/Practitioner | http://hl7.org/fhir/StructureDefinition/Patient | http://hl7.org/fhir/StructureDefinition/RelatedPerson) | ||
time | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.note.time When the annotation was made DefinitionIndicates when this particular annotation was made. dateTime Constraints
|
text | 1..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.note.text The annotation - text content DefinitionThe text of the annotation. Note that FHIR strings may not exceed 1MB in size string Constraints
|