Releases of the PS-CA Implementation Guide may be found on a table on the Home Page of this Project.
AllergyIntolerance (PS-CA)
Additional information on this profile (including the JSON & XML structure and detailed element descriptions) can be found at package/structuredefinition-profile-allergyintolerance-ca-ps.json
Profile
AllergyIntolerance | I | 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.
| |
id | Σ | 0..1 | string | 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. |
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 might not always be associated with version changes to the resource.
|
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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
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). A human language.
| |
text | 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 can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
abatement-datetime | I | 0..1 | Extension(dateTime) | Element idAllergyIntolerance.extension:abatement-datetime Extension for representing Abatement datetime Alternate namesextensions, user content DefinitionThe date or estimated date that the condition resolved or went into remission. 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. http://hl7.org/fhir/uv/ips/StructureDefinition/abatement-dateTime-uv-ips 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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. 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 DefinitionBusiness identifiers assigned to this AllergyIntolerance by the performer or other systems which remain constant as the resource is updated and propagates from server to server. Allows identification of the AllergyIntolerance as it is known by various participating systems and in a way that remains consistent across servers. This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
|
clinicalStatus | Σ ?! I | 0..1 | CodeableConceptBinding | Element idAllergyIntolerance.clinicalStatus active | inactive | resolved DefinitionThe clinical status of the allergy or intolerance. IPS-UV no longer flags this as a Must Support Element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. FHIR Base Note: This element is a modifier element with a required vocabulary binding in the base FHIR specification. IPS-UV Note: In the scope of the IPS-UV the entered-in-error concept is not allowed and so the modifier on this element has been removed. The clinical status of the allergy or intolerance.
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.clinicalStatus.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.clinicalStatus.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..* | Coding | Element idAllergyIntolerance.clinicalStatus.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Many Canadian systems currently use the AllergyIntoleranceStatusCode value set comprised of SNOMED CT codes. Additionally, some Canadian systems that have implemented HL7 V3 are currently using HL7 v3 Value Set ActStatus. Both can be mapped and provided as additional codings to the required FHIR AllergyIntolerance clinicalStatus codes. The element is sliced to express the required population of at least the HL7AllergyIntoleranceClinicalStatus slice since it is a required coding. Unordered, Open, by $this(Pattern) Discriminated by the bound value set Constraints
|
HL7AllergyIntoleranceClinicalStatus | Σ | 1..1 | CodingBinding | Element idAllergyIntolerance.clinicalStatus.coding:HL7AllergyIntoleranceClinicalStatus Required value set for AllergyIntolerance Clinical Status. DefinitionThe clinical status of an allergy or intolerance. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. HL7 required value set for AllergyIntolerance Clinical Status.
|
statusCodeSCTCA | Σ | 0..* | CodingBinding | Element idAllergyIntolerance.clinicalStatus.coding:statusCodeSCTCA Code for allergy or intolerance status DefinitionCode for an allergy or intolerance statement. Represents whether an allergy/intolerance is active or resolved (indicating no longer active). Allows for alternative encodings within a code system, and translations to other code systems. This value set combines concepts that can be mapped to clinical status as well as verification status concepts. Implementers are expected to utilize concept maps to ensure the code captured in the source is appropriately mapped to the correct allergy intolerance element. Represents whether an allergy/intolerance is “active” or resolved (indicating no longer active).
|
ActStatusCodeV3 | Σ | 0..* | CodingBinding | Element idAllergyIntolerance.clinicalStatus.coding:ActStatusCodeV3 HL7 V3 ActStatus code DefinitionCodes representing the defined possible states of an Act, as defined by the Act class state machine. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Represents an ActStatus code used by systems implementing HL7 V3.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.clinicalStatus.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
verificationStatus | Σ ?! I | 0..1 | CodeableConceptBinding | Element idAllergyIntolerance.verificationStatus unconfirmed | confirmed | refuted | entered-in-error DefinitionAssertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product). IPS-UV no longer flags this as a Must Support Element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. FHIR Base Note: This element is a modifier element with a required vocabulary binding in the base FHIR specification. IPS-UV Note: In the scope of the IPS-UV the entered-in-error concept is not allowed and so the modifier on this element has been removed. Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.verificationStatus.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idAllergyIntolerance.verificationStatus.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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
coding | Σ | 1..* | Coding | Element idAllergyIntolerance.verificationStatus.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Many Canadian systems currently use the AllergyIntoleranceStatusCode value set comprised of SNOMED CT codes that can be mapped and provided as additional codings to the required FHIR AllergyIntolerance-verification codes. The element is sliced to express the required population of at least the HL7VerificationStatus slice since it is a required coding. Unordered, Open, by $this(Pattern) Discriminated by the bound value set Constraints
|
HL7VerificationStatus | Σ | 1..* | CodingBinding | Element idAllergyIntolerance.verificationStatus.coding:HL7VerificationStatus Required value set for AllergyIntolerance Verification Status. DefinitionCode for an allergy or intolerance statement. Represents whether an allergy/intolerance is active or resolved (indicating no longer active). Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. HL7 required value set for AllergyIntolerance Verification Status.
|
statusCodeSCTCA | Σ | 0..* | CodingBinding | Element idAllergyIntolerance.verificationStatus.coding:statusCodeSCTCA Code for allergy or intolerance status DefinitionCode for an allergy or intolerance statement. Represents whether an allergy/intolerance is active or resolved but also includes values like confirmed present and refuted Allows for alternative encodings within a code system, and translations to other code systems. This value set combines concepts that can be mapped to clinical status as well as verification status concepts. Implementers are expected to utilize concept maps to ensure the code captured in the source is appropriately mapped to the correct allergy intolerance element. Represents whether an allergy/intolerance is “active” or resolved (indicating no longer active).
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.verificationStatus.text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
type | Σ | 0..1 | codeBinding | Element idAllergyIntolerance.type allergy | intolerance - Underlying mechanism (if known) Alternate namesCategory, Class DefinitionIdentification of the underlying physiological mechanism for the reaction risk. IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content. Identification of the underlying physiological mechanism for a Reaction Risk.
|
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. Category of an identified substance associated with allergies or intolerances.
|
criticality | Σ | 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. Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.
|
code | S Σ | 1..1 | package/structuredefinition-profile-codeableconcept-ca-ps.jsonBinding | Element idAllergyIntolerance.code Concept - reference to a terminology or just text Alternate namesCode DefinitionA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Many Canadian implementations use codes from either SNOMED CT and the SNOMED CT Canada Extension to describe this concept, while others may still be using localized code systems or text descriptions. The AllergyIntoleranceSubstanceCondition - IPS ValueSet contains codes that are subsumed within the SNOMED CT CA SubstanceAndPharmaceuticalBiologicProductCode ValueSet that is preferred for this element. See additionalBinding extension. Future releases of PS-CA may require use of coded entries. In this release, however, implementations that support codings are encouraged to send the codings for codeable concepts if they are available. Consistent with FHIR best practice, receivers should not produce failures or rejections if codings are received. Vendors should expect that some jurisdictions may further constrain support of this element within the context of their own jurisdictional content. package/structuredefinition-profile-codeableconcept-ca-ps.json BindingCodes for that combine substance and pharmaceuticalbiologicproduct value sets from the SNOMED CT Canadian edition
|
patient | S Σ I | 1..1 | Reference(package/structuredefinition-profile-patient-ca-ps.json) | 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(package/structuredefinition-profile-patient-ca-ps.json) Constraints
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.patient.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
reference | S Σ I | 1..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.patient.reference Literal reference, Relative, internal or absolute URL DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
|
type | Σ | 0..1 | uriBinding | There are no (further) constraints on this element Element idAllergyIntolerance.patient.type Type the reference refers to (e.g. "Patient") DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Aa resource (or, for logical models, the URI of the logical model).
|
identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idAllergyIntolerance.patient.identifier Logical reference, when literal reference is not known DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.patient.display Text alternative for the resource DefinitionPlain text narrative that identifies the resource in addition to the resource reference. This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
|
encounter | I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idAllergyIntolerance.encounter Encounter when the allergy or intolerance was asserted DefinitionThe encounter when the allergy or intolerance was asserted. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
onset[x] | 0..1 | Element idAllergyIntolerance.onset[x] When allergy or intolerance was identified DefinitionEstimated or actual date, date-time, or age when allergy or intolerance was identified. Unordered, Open, by $this(Type) Constraints
| ||
onsetAge | Age | There are no (further) constraints on this element Data type | ||
onsetPeriod | Period | There are no (further) constraints on this element Data type | ||
onsetRange | Range | There are no (further) constraints on this element Data type | ||
onsetString | string | There are no (further) constraints on this element Data type | ||
onsetDateTime | S | 0..1 | dateTime | There are no (further) constraints on this element Element idAllergyIntolerance.onset[x]:onsetDateTime When allergy or intolerance was identified DefinitionEstimated or actual date, date-time, or age when allergy or intolerance was identified.
|
recordedDate | 0..1 | dateTime | There are no (further) constraints on this element Element idAllergyIntolerance.recordedDate Date first version of the resource instance was recorded DefinitionThe recordedDate represents when this particular AllergyIntolerance record was created in the system, which is often a system-generated date.
| |
recorder | I | 0..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | There are no (further) constraints on this element Element idAllergyIntolerance.recorder Who recorded the sensitivity Alternate namesAuthor DefinitionIndividual who recorded the record and takes responsibility for its content. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Constraints
|
asserter | Σ I | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idAllergyIntolerance.asserter Source of the information about the allergy Alternate namesSource, Informant DefinitionThe source of the information about the allergy that is recorded. The recorder takes responsibility for the content, but can reference the source from where they got it. Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) Constraints
|
lastOccurrence | 0..1 | dateTime | There are no (further) constraints on this element Element idAllergyIntolerance.lastOccurrence Date(/time) of last known occurrence of a reaction DefinitionRepresents the date and/or time of the last known occurrence of a reaction event. This date may be replicated by one of the Onset of Reaction dates. Where a textual representation of the date of last occurrence is required e.g. 'In Childhood, '10 years ago' the Comment element should be used.
| |
note | 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.
| |
reaction | S | 0..* | BackboneElement | There are no (further) constraints on this element Element idAllergyIntolerance.reaction Adverse Reaction Events linked to exposure to substance DefinitionDetails about each adverse reaction event linked to exposure to the identified substance.
|
id | 0..1 | string | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. 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 even if unrecognized 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
substance | 0..1 | CodeableConcept | Element idAllergyIntolerance.reaction.substance Specific substance or pharmaceutical product considered to be responsible for event DefinitionIdentification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the 'code' and ignore the 'reaction.substance'. If a receiving system is unable to confirm that AllergyIntolerance.reaction.substance falls within the semantic scope of AllergyIntolerance.code, then the receiving system should ignore AllergyIntolerance.reaction.substance. The IPS-UV does not consider this element Must Support, however some Canadian systems may capture allergen substances separately from AllergyIntolerance.code. Further investigation is required to determine what approaches are in use by participating jurisdictions. Codes defining the type of the substance (including pharmaceutical products).
| |
manifestation | S | 1..* | package/structuredefinition-profile-codeableconcept-ca-ps.jsonBinding | 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. Future releases of PS-CA may require use of coded entries. In this release, however, implementers that support codings are encouraged to send the codings for codeable concepts if they are available. Consistent with FHIR best practice, receivers should not produce failures or rejections if codings are received. Vendors should expect that some jurisdictions may further constrain support of this element within the context of their own jurisdictional content. See guidance in Missing Data Expectations section in the Profiling Conventions page of the guide for cases where the system wants to convey that the manifestation is package/structuredefinition-profile-codeableconcept-ca-ps.json BindingCodes for the allergy or intolerance reaction manifestation from the SNOMED CT Canadian edition value set
|
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.
| |
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.
| |
severity | 0..1 | codeBinding | 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. IPS-UV flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a Must Support requirement within the context of their own jurisdictional content. Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.
| |
exposureRoute | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idAllergyIntolerance.reaction.exposureRoute How the subject was exposed to the substance DefinitionIdentification of the route by which the subject was exposed to the substance. Coding of the route of exposure with a terminology should be used wherever possible. A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.
| |
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.
|
Extensions
This profile uses the following extensions:
AllergyIntolerance
: Allergy abatement date
Key Differences between the IPS-UV and PS-CA
Must Support Differences:
The following elements are considered Must Support in the Allergy Intolerance (IPS) profile that are relaxed in this version of the PS-CA profile:
AllergyIntolerance.extension
abatement-datetime slice- Note that while the MS flag is relaxed in the differential, it still shows in the renderer until the extension modeling is further corrected by IPS
AllergyIntolerance.type
AllergyIntolerance.reaction.severity
Note: Systems that support these elements are encouraged to send them in patient summaries
Cardinality Differences:
There are no cardinality differences between this profile and IPS-UV
Vocabulary Differences:
AllergyIntolerance.clinicalStatus
andAllergyIntolerance.verificationStatus
- optional slices added for SNOMED CT Canadian Edition package/valueset-allergyintolerancestatuscode.json and HL7 v3.ActStatus
- Note: In a handful of areas where the Base FHIR specification has a required binding on a CodeableConcept (and there is evidence of substantial use of legacy code systems like v3), slicing has been maintained. This has been done to demonstrate that the required coding must be sent, but the legacy coding that is a semantic match can still be sent as an additional coding.
AllergyIntolerance.code
- Added preferred binding of package/valueset-substanceandpharmaceuticalbiologicproductcode.json (CCDD)
- additionalBindings added for:
- CCDD package/valueset-canadianclinicaldrugdataset.json,
- Licensed Natural Health Products package/valueset-LicensedNaturalHealthProducts.json,
- ICD-10 CA codes package/valueset-icd10cacode.json,
- absent or unknown allergies AbsentOrUnknownAllergiesUvIps
AllergyIntolerance.reaction.manifestation
- Added preferred binding of SNOMED CT Canadian Edition package/valueset-clinicalfindingcode.json
- For additional guidance on what expectations on when data is missing please refer to this page for the Missing Data Expectations section
Other differences between the IPS and PS-CA Include:
Data type profiles (e.g., CodeableConcept) and reference targets (e.g., Patient) replaced with PS-CA equivalents when appropriate
AllergyIntolerance.clinicalStatus
- removed IPS datatype profile
AllergyIntolerance.verificationStatus
- removed IPS datatype profile
AllergyIntolerance.reaction.manifestation
- comment added about future potential use of coded elements