Profiles
The following Profiles are defined for Adverse Event Reporting.
AdverseEvent
| AdverseEvent | I | AdverseEvent | There are no (further) constraints on this element Element idAdverseEvent Medical care, research study or other healthcare event causing physical injury Alternate namesAE DefinitionActual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.
| |
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idAdverseEvent.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 idAdverseEvent.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 idAdverseEvent.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 idAdverseEvent.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 idAdverseEvent.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 idAdverseEvent.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 | Element idAdverseEvent.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
|
| grade | I | 0..1 | Extension(CodeableConcept) | Element idAdverseEvent.extension:grade Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. https://fhir.devdays.com/R4/devdays-covid19-vaccine/StructureDefinition/adverse-event-grade Constraints
|
| modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idAdverseEvent.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..1 | Identifier | There are no (further) constraints on this element Element idAdverseEvent.identifier Business identifier for the event DefinitionBusiness identifiers assigned to this adverse event by the performer or other systems which remain constant as the resource is updated and propagates from server to server. Allows identification of the adverse event 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.
|
| actuality | Σ ?! | 1..1 | codeBindingPattern | Element idAdverseEvent.actuality actual | potential DefinitionWhether the event actually happened, or just had the potential to. Note that this is independent of whether anyone was affected or harmed or how severely. Note that FHIR strings SHALL NOT exceed 1MB in size Overall nature of the adverse event, e.g. real or potential.
actual
|
| category | Σ | 1..* | CodeableConceptBindingPattern | Element idAdverseEvent.category product-problem | product-quality | product-use-error | wrong-dose | incorrect-prescribing-information | wrong-technique | wrong-route-of-administration | wrong-rate | wrong-duration | wrong-time | expired-drug | medical-device-use-error | problem-different-manufacturer | unsafe-physical-environment DefinitionThe overall type of event, intended for search and filtering purposes. 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. Overall categorization of the event, e.g. product-related or situational.
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "264519003"
}
]
}
|
| event | Σ | 1..1 | CodeableConceptBinding | Element idAdverseEvent.event Type of the event itself in relation to the subject DefinitionThis element defines the specific type of event that occurred or that was prevented from occurring. 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. Detailed type of event.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idAdverseEvent.event.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 idAdverseEvent.event.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 | Σ | 0..* | Coding | There are no (further) constraints on this element Element idAdverseEvent.event.coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
| text | Σ | 1..1 | string | There are no (further) constraints on this element Element idAdverseEvent.event.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.
|
| subject | Σ I | 1..1 | Reference(Patient) | Element idAdverseEvent.subject Subject impacted by event Alternate namespatient DefinitionThis subject or group impacted by the event. Allows for exposure of biohazard (such as legionella) to a group of individuals in a hospital. If AdverseEvent.resultingCondition differs among members of the group, then use Patient as the subject.
|
| encounter | Σ I | 0..1 | Reference(Encounter) | There are no (further) constraints on this element Element idAdverseEvent.encounter Encounter created as part of DefinitionThe Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated. This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. For example, if a medication administration was considered an adverse event because it resulted in a rash, then the encounter when the medication administration was given is the context. If the patient reports the AdverseEvent during a second encounter, that second encounter is not the context.
|
| date | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idAdverseEvent.date When the event occurred DefinitionThe date (and perhaps time) when the adverse event occurred.
|
| detected | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idAdverseEvent.detected When the event was detected DefinitionEstimated or actual date the AdverseEvent began, in the opinion of the reporter.
|
| recordedDate | Σ | 0..1 | dateTime | There are no (further) constraints on this element Element idAdverseEvent.recordedDate When the event was recorded DefinitionThe date on which the existence of the AdverseEvent was first recorded. The recordedDate represents the date when this particular AdverseEvent record was created in the system, not the date of the most recent update. The date of the last record modification can be retrieved from the resource metadata.
|
| resultingCondition | Σ I | 0..* | Reference(Condition) | There are no (further) constraints on this element Element idAdverseEvent.resultingCondition Effect on the subject due to this event DefinitionIncludes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical). 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.
|
| location | Σ I | 0..1 | Reference(Location) | There are no (further) constraints on this element Element idAdverseEvent.location Location where adverse event occurred DefinitionThe information about where the adverse event occurred. 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.
|
| seriousness | Σ | 0..1 | CodeableConceptBinding | Element idAdverseEvent.seriousness Seriousness of the event DefinitionAssessment whether this event was of real importance. 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. Overall seriousness of this event for the patient.
|
| severity | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idAdverseEvent.severity mild | moderate | severe DefinitionDescribes the severity of the adverse event, in relation to the subject. Contrast to AdverseEvent.seriousness - a severe rash might not be serious, but a mild heart problem is. 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. The severity of the adverse event itself, in direct relation to the subject.
|
| outcome | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idAdverseEvent.outcome resolved | recovering | ongoing | resolvedWithSequelae | fatal | unknown DefinitionDescribes the type of outcome from the adverse event. 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. TODO (and should this be required?).
|
| recorder | Σ I | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | There are no (further) constraints on this element Element idAdverseEvent.recorder Who recorded the adverse event DefinitionInformation on who recorded the adverse event. May be the patient or a practitioner. 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(Patient | Practitioner | PractitionerRole | RelatedPerson) Constraints
|
| contributor | Σ I | 0..* | Reference(Practitioner | PractitionerRole | Device) | There are no (further) constraints on this element Element idAdverseEvent.contributor Who was involved in the adverse event or the potential adverse event DefinitionParties that may or should contribute or have contributed information to the adverse event, which can consist of one or more activities. Such information includes information leading to the decision to perform the activity and how to perform the activity (e.g. consultant), information that the activity itself seeks to reveal (e.g. informant of clinical history), or information about what activity was performed (e.g. informant witness). 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 | Device) Constraints
|
| suspectEntity | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idAdverseEvent.suspectEntity The suspected agent causing the adverse event DefinitionDescribes the entity that is suspected to have caused the adverse event.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idAdverseEvent.suspectEntity.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 idAdverseEvent.suspectEntity.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 idAdverseEvent.suspectEntity.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.
|
| instance | Σ I | 1..1 | Reference(Immunization) | Element idAdverseEvent.suspectEntity.instance Refers to the specific entity that caused the adverse event Alternate namesSubstance or Medication or Device DefinitionIdentifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device. 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.
|
| causality | Σ | 0..* | BackboneElement | There are no (further) constraints on this element Element idAdverseEvent.suspectEntity.causality Information on the possible cause of the event DefinitionInformation on the possible cause of the event.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idAdverseEvent.suspectEntity.causality.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 idAdverseEvent.suspectEntity.causality.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 idAdverseEvent.suspectEntity.causality.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.
|
| assessment | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idAdverseEvent.suspectEntity.causality.assessment Assessment of if the entity caused the event DefinitionAssessment of if the entity caused the event. 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. Codes for the assessment of whether the entity caused the event.
|
| productRelatedness | Σ | 0..1 | string | There are no (further) constraints on this element Element idAdverseEvent.suspectEntity.causality.productRelatedness AdverseEvent.suspectEntity.causalityProductRelatedness DefinitionAdverseEvent.suspectEntity.causalityProductRelatedness. Note that FHIR strings SHALL NOT exceed 1MB in size
|
| author | Σ I | 0..1 | Reference(Practitioner | PractitionerRole) | There are no (further) constraints on this element Element idAdverseEvent.suspectEntity.causality.author AdverseEvent.suspectEntity.causalityAuthor DefinitionAdverseEvent.suspectEntity.causalityAuthor. 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) Constraints
|
| method | Σ | 0..1 | CodeableConcept | There are no (further) constraints on this element Element idAdverseEvent.suspectEntity.causality.method ProbabilityScale | Bayesian | Checklist DefinitionProbabilityScale | Bayesian | Checklist. 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. TODO.
|
| subjectMedicalHistory | Σ I | 0..* | Reference(Condition | Observation | AllergyIntolerance | FamilyMemberHistory | Immunization | Procedure | Media | DocumentReference) | There are no (further) constraints on this element Element idAdverseEvent.subjectMedicalHistory AdverseEvent.subjectMedicalHistory DefinitionAdverseEvent.subjectMedicalHistory. 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(Condition | Observation | AllergyIntolerance | FamilyMemberHistory | Immunization | Procedure | Media | DocumentReference) Constraints
|
| referenceDocument | Σ I | 0..* | Reference(DocumentReference) | There are no (further) constraints on this element Element idAdverseEvent.referenceDocument AdverseEvent.referenceDocument DefinitionAdverseEvent.referenceDocument. 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.
|
| study | Σ I | 0..* | Reference(ResearchStudy) | There are no (further) constraints on this element Element idAdverseEvent.study AdverseEvent.study DefinitionAdverseEvent.study. 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.
|