Adverse Event Clinical Research
1.0.0-ballot - ballot International flag

This page is part of the Adverse Event Clinical Research (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: Adverse Event Clinical Research

Official URL: http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/AdverseEvent-clinical-research Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: AdverseEventClinicalResearch

An example profile of AdverseEvent for Research reporting.

Scope and Usage

The Clinical Research adverse event profile of AdverseEvent, is for the clinical research setting. Adverse events are tracked and evaluated as part of the clinical research process in a research study, as the occurrence of an adverse event may surface a potential confounder or a potential side-effect of the study treatment. In the research setting an adverse event is the result of an intervention that caused unintentional harm to a specific subject or group of subjects, potential adverse events are not reported (this is surfaced in the profile as a constraint of ‘actual’ for the value of ‘actuality’). Examples of adverse events include the administration of an incorrect drug or an incorrect dose of a drug causing an adverse reaction, the use of an implanted device that causes an infection, or a biologic used during a research study that causes unanticipated renal failure. These events are characterized by the need to capture cause and effect (although they might not be known at the time of the event), severity, and outcome.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from AdverseEvent

NameFlagsCard.TypeDescription & Constraintsdoco
.. AdverseEvent C0..*AdverseEventAn event that may be related to unintended effects on a patient or research participant
aeClinRes-seriousness-1: If seriousness is serious then must have at least one seriousness criterion.
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... caused-subject-to-discontinue-study 0..1booleanAdverse event caused subject to discontinue the study
URL: http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/caused-subject-to-discontinue-study
... seriousness-criteria 0..*(Complex)Criteria reviewed in determining serious adverse event
URL: http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/seriousness-criteria
... actuality 1..1codeactual
Required Pattern: actual
... occurrence[x] S0..1PeriodWhen the event occurred
... resultingEffect 0..*Reference(Condition | Observation)Effect on the subject due to this event
... seriousness S1..1CodeableConceptInvestigator defined severity of the adverse event, in relation to the subject not the resulting condition
Binding: AdverseEventSeriousness (required)
... outcome S1..1CodeableConceptType of outcome from the adverse event
Binding: Adverse Event Clinical Research Outcomes (required)
... study S1..1Reference(ResearchStudy)Research study that the subject is enrolled in
... suspectEntity
.... causality S1..1BackboneElementInformation on the possible cause of the event
..... assessmentMethod 0..1CodeableConceptMethod of evaluating the relatedness of the suspected entity to the event.
Binding: AdverseEventCausalityMethod (preferred): Codes for the method of evaluating the relatedness of the suspected entity to the event, such as ProbabilityScale | Bayesian | Checklist.

..... entityRelatedness 0..1CodeableConceptResult of the assessment regarding the relatedness of the suspected entity to the event
Binding: Causality Relatedness values (preferred)
... preventiveAction 0..0
... supportingInfo
.... item[x] 1..1Reference(Condition | Observation | AllergyIntolerance | FamilyMemberHistory | Immunization | Procedure | DocumentReference | MedicationAdministration | MedicationStatement | QuestionnaireResponse), CodeableConceptSubject medical history or document relevant to this adverse event
Binding: AdverseEventSupportingInforation (example): Codes describing the supporting information relevant to the event.


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
AdverseEvent.seriousnessrequiredAdverseEventSeriousness
AdverseEvent.outcomerequiredOutcomeAEClinRes
AdverseEvent.suspectEntity.causality.assessmentMethodpreferredAdverseEventCausalityMethod
AdverseEvent.suspectEntity.causality.entityRelatednesspreferredCausalityRelatedness
AdverseEvent.supportingInfo.item[x]exampleAdverseEventSupportingInforation

Constraints

IdGradePath(s)DetailsRequirements
aeClinRes-seriousness-1errorAdverseEventIf seriousness is serious then must have at least one seriousness criterion.
: (seriousness.coding .exists(system='http://terminology.hl7.org/CodeSystem/adverse-event-seriousness' and code='serious') and extension('http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/seriousness-criteria').exists() and seriousness.coding .exists(system='http://terminology.hl7.org/CodeSystem/adverse-event-seriousness' and code='non-serious').not() ) or (seriousness.coding.exists(system='http://terminology.hl7.org/CodeSystem/adverse-event-seriousness' and code='non-serious') and seriousness.coding .exists(system='http://terminology.hl7.org/CodeSystem/adverse-event-seriousness' and code='serious').not() and extension('http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/seriousness-criteria').exists().not() )
NameFlagsCard.TypeDescription & Constraintsdoco
.. AdverseEvent C0..*AdverseEventAn event that may be related to unintended effects on a patient or research participant
aeClinRes-seriousness-1: If seriousness is serious then must have at least one seriousness criterion.
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... seriousness-criteria 0..*(Complex)Criteria reviewed in determining serious adverse event
URL: http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/seriousness-criteria
... severity-or-grade 0..1CodeableConceptThe degree of something undesirable
URL: http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/severity-or-grade
Binding: AdverseEvent Severity or Grade Value Set (preferred)
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codein-progress | completed | entered-in-error | unknown
Binding: AdverseEventStatus (required): Codes identifying the lifecycle stage of an event.

... actuality ?!Σ1..1codeactual
Binding: AdverseEventActuality (required): Overall nature of the adverse event, e.g. real or potential.


Required Pattern: actual
... subject Σ1..1Reference(Patient | Group | Practitioner | RelatedPerson | ResearchSubject)Subject impacted by event
... occurrence[x] SΣ0..1PeriodWhen the event occurred
... resultingEffect Σ0..*Reference(Condition | Observation)Effect on the subject due to this event
... seriousness SΣ1..1CodeableConceptInvestigator defined severity of the adverse event, in relation to the subject not the resulting condition
Binding: AdverseEventSeriousness (required)
... outcome SΣ1..1CodeableConceptType of outcome from the adverse event
Binding: Adverse Event Clinical Research Outcomes (required)
... study SΣ1..1Reference(ResearchStudy)Research study that the subject is enrolled in
... suspectEntity Σ0..*BackboneElementThe suspected agent causing the adverse event
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... instance[x] Σ1..1Refers to the specific entity that caused the adverse event
..... instanceCodeableConceptCodeableConcept
..... instanceReferenceReference(Immunization | Procedure | Substance | Medication | MedicationAdministration | MedicationStatement | Device | BiologicallyDerivedProduct | ResearchStudy)
.... causality SΣ1..1BackboneElementInformation on the possible cause of the event
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... assessmentMethod Σ0..1CodeableConceptMethod of evaluating the relatedness of the suspected entity to the event.
Binding: AdverseEventCausalityMethod (preferred): Codes for the method of evaluating the relatedness of the suspected entity to the event, such as ProbabilityScale | Bayesian | Checklist.

..... entityRelatedness Σ0..1CodeableConceptResult of the assessment regarding the relatedness of the suspected entity to the event
Binding: Causality Relatedness values (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
AdverseEvent.statusrequiredAdverseEventStatus
AdverseEvent.actualityrequiredPattern: actual
AdverseEvent.seriousnessrequiredAdverseEventSeriousness
AdverseEvent.outcomerequiredOutcomeAEClinRes
AdverseEvent.suspectEntity.causality.assessmentMethodpreferredAdverseEventCausalityMethod
AdverseEvent.suspectEntity.causality.entityRelatednesspreferredCausalityRelatedness
AdverseEvent.preventiveAction.item[x]exampleAdverseEventPreventiveAction

Constraints

IdGradePath(s)DetailsRequirements
aeClinRes-seriousness-1errorAdverseEventIf seriousness is serious then must have at least one seriousness criterion.
: (seriousness.coding .exists(system='http://terminology.hl7.org/CodeSystem/adverse-event-seriousness' and code='serious') and extension('http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/seriousness-criteria').exists() and seriousness.coding .exists(system='http://terminology.hl7.org/CodeSystem/adverse-event-seriousness' and code='non-serious').not() ) or (seriousness.coding.exists(system='http://terminology.hl7.org/CodeSystem/adverse-event-seriousness' and code='non-serious') and seriousness.coding .exists(system='http://terminology.hl7.org/CodeSystem/adverse-event-seriousness' and code='serious').not() and extension('http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/seriousness-criteria').exists().not() )
dom-2errorAdverseEventIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAdverseEventIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorAdverseEventIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorAdverseEventIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAdverseEventA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. AdverseEvent C0..*AdverseEventAn event that may be related to unintended effects on a patient or research participant
aeClinRes-seriousness-1: If seriousness is serious then must have at least one seriousness criterion.
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... caused-subject-to-discontinue-study 0..1booleanAdverse event caused subject to discontinue the study
URL: http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/caused-subject-to-discontinue-study
... seriousness-criteria 0..*(Complex)Criteria reviewed in determining serious adverse event
URL: http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/seriousness-criteria
... severity-or-grade 0..1CodeableConceptThe degree of something undesirable
URL: http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/severity-or-grade
Binding: AdverseEvent Severity or Grade Value Set (preferred)
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for the event
... status ?!Σ1..1codein-progress | completed | entered-in-error | unknown
Binding: AdverseEventStatus (required): Codes identifying the lifecycle stage of an event.

... actuality ?!Σ1..1codeactual
Binding: AdverseEventActuality (required): Overall nature of the adverse event, e.g. real or potential.


Required Pattern: actual
... category Σ0..*CodeableConceptwrong-patient | procedure-mishap | medication-mishap | device | unsafe-physical-environment | hospital-aquired-infection | wrong-body-site
Binding: AdverseEventCategory (example): Overall categorization of the event, e.g. product-related or situational.


... code Σ0..1CodeableConceptEvent or incident that occurred or was averted
Binding: AdverseEventType (example): Detailed type of event.

... subject Σ1..1Reference(Patient | Group | Practitioner | RelatedPerson | ResearchSubject)Subject impacted by event
... encounter Σ0..1Reference(Encounter)The Encounter associated with the start of the AdverseEvent
... occurrence[x] SΣ0..1PeriodWhen the event occurred
... detected Σ0..1dateTimeWhen the event was detected
... recordedDate Σ0..1dateTimeWhen the event was recorded
... resultingEffect Σ0..*Reference(Condition | Observation)Effect on the subject due to this event
... location Σ0..1Reference(Location)Location where adverse event occurred
... seriousness SΣ1..1CodeableConceptInvestigator defined severity of the adverse event, in relation to the subject not the resulting condition
Binding: AdverseEventSeriousness (required)
... outcome SΣ1..1CodeableConceptType of outcome from the adverse event
Binding: Adverse Event Clinical Research Outcomes (required)
... recorder Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | ResearchSubject)Who recorded the adverse event
... participant Σ0..*BackboneElementWho was involved in the adverse event or the potential adverse event and what they did
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function Σ0..1CodeableConceptType of involvement
Binding: AdverseEventParticipantFunction (example): Codes describing the type of involvement of the actor in the adverse event.

.... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | ResearchSubject)Who was involved in the adverse event or the potential adverse event
... study SΣ1..1Reference(ResearchStudy)Research study that the subject is enrolled in
... expectedInResearchStudy 0..1booleanConsidered likely or probable or anticipated in the research study
... suspectEntity Σ0..*BackboneElementThe suspected agent causing the adverse event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... instance[x] Σ1..1Refers to the specific entity that caused the adverse event
..... instanceCodeableConceptCodeableConcept
..... instanceReferenceReference(Immunization | Procedure | Substance | Medication | MedicationAdministration | MedicationStatement | Device | BiologicallyDerivedProduct | ResearchStudy)
.... causality SΣ1..1BackboneElementInformation on the possible cause of the event
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... assessmentMethod Σ0..1CodeableConceptMethod of evaluating the relatedness of the suspected entity to the event.
Binding: AdverseEventCausalityMethod (preferred): Codes for the method of evaluating the relatedness of the suspected entity to the event, such as ProbabilityScale | Bayesian | Checklist.

..... entityRelatedness Σ0..1CodeableConceptResult of the assessment regarding the relatedness of the suspected entity to the event
Binding: Causality Relatedness values (preferred)
..... author Σ0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | ResearchSubject)Author of the information on the possible cause of the event
... contributingFactor Σ0..*BackboneElementContributing factors suspected to have increased the probability or severity of the adverse event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] Σ1..1Item suspected to have increased the probability or severity of the adverse event
Binding: AdverseEventContributingFactor (example): Codes describing the contributing factors suspected to have increased the probability or severity of the adverse event.

..... itemReferenceReference(Condition | Observation | AllergyIntolerance | FamilyMemberHistory | Immunization | Procedure | Device | DeviceUsage | DocumentReference | MedicationAdministration | MedicationStatement)
..... itemCodeableConceptCodeableConcept
... mitigatingAction Σ0..*BackboneElementAmeliorating actions taken after the adverse event occured in order to reduce the extent of harm
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] Σ1..1Ameliorating action taken after the adverse event occured in order to reduce the extent of harm
Binding: AdverseEventMitigatingAction (example): Codes describing the ameliorating actions taken after the adverse event occured in order to reduce the extent of harm.

..... itemReferenceReference(Procedure | DocumentReference | MedicationAdministration | MedicationRequest)
..... itemCodeableConceptCodeableConcept
... supportingInfo Σ0..*BackboneElementSupporting information relevant to the event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] Σ1..1Subject medical history or document relevant to this adverse event
Binding: AdverseEventSupportingInforation (example): Codes describing the supporting information relevant to the event.

..... itemReferenceReference(Condition | Observation | AllergyIntolerance | FamilyMemberHistory | Immunization | Procedure | DocumentReference | MedicationAdministration | MedicationStatement | QuestionnaireResponse)
..... itemCodeableConceptCodeableConcept
... note Σ0..*AnnotationComment on adverse event

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
AdverseEvent.languagerequiredAllLanguages
AdverseEvent.statusrequiredAdverseEventStatus
AdverseEvent.actualityrequiredPattern: actual
AdverseEvent.categoryexampleAdverseEventCategory
AdverseEvent.codeexampleAdverseEventType
AdverseEvent.seriousnessrequiredAdverseEventSeriousness
AdverseEvent.outcomerequiredOutcomeAEClinRes
AdverseEvent.participant.functionexampleAdverseEventParticipantFunction
AdverseEvent.suspectEntity.causality.assessmentMethodpreferredAdverseEventCausalityMethod
AdverseEvent.suspectEntity.causality.entityRelatednesspreferredCausalityRelatedness
AdverseEvent.contributingFactor.item[x]exampleAdverseEventContributingFactor
AdverseEvent.preventiveAction.item[x]exampleAdverseEventPreventiveAction
AdverseEvent.mitigatingAction.item[x]exampleAdverseEventMitigatingAction
AdverseEvent.supportingInfo.item[x]exampleAdverseEventSupportingInforation

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AdverseEvent

Differential View

This structure is derived from AdverseEvent

NameFlagsCard.TypeDescription & Constraintsdoco
.. AdverseEvent C0..*AdverseEventAn event that may be related to unintended effects on a patient or research participant
aeClinRes-seriousness-1: If seriousness is serious then must have at least one seriousness criterion.
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... caused-subject-to-discontinue-study 0..1booleanAdverse event caused subject to discontinue the study
URL: http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/caused-subject-to-discontinue-study
... seriousness-criteria 0..*(Complex)Criteria reviewed in determining serious adverse event
URL: http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/seriousness-criteria
... actuality 1..1codeactual
Required Pattern: actual
... occurrence[x] S0..1PeriodWhen the event occurred
... resultingEffect 0..*Reference(Condition | Observation)Effect on the subject due to this event
... seriousness S1..1CodeableConceptInvestigator defined severity of the adverse event, in relation to the subject not the resulting condition
Binding: AdverseEventSeriousness (required)
... outcome S1..1CodeableConceptType of outcome from the adverse event
Binding: Adverse Event Clinical Research Outcomes (required)
... study S1..1Reference(ResearchStudy)Research study that the subject is enrolled in
... suspectEntity
.... causality S1..1BackboneElementInformation on the possible cause of the event
..... assessmentMethod 0..1CodeableConceptMethod of evaluating the relatedness of the suspected entity to the event.
Binding: AdverseEventCausalityMethod (preferred): Codes for the method of evaluating the relatedness of the suspected entity to the event, such as ProbabilityScale | Bayesian | Checklist.

..... entityRelatedness 0..1CodeableConceptResult of the assessment regarding the relatedness of the suspected entity to the event
Binding: Causality Relatedness values (preferred)
... preventiveAction 0..0
... supportingInfo
.... item[x] 1..1Reference(Condition | Observation | AllergyIntolerance | FamilyMemberHistory | Immunization | Procedure | DocumentReference | MedicationAdministration | MedicationStatement | QuestionnaireResponse), CodeableConceptSubject medical history or document relevant to this adverse event
Binding: AdverseEventSupportingInforation (example): Codes describing the supporting information relevant to the event.


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
AdverseEvent.seriousnessrequiredAdverseEventSeriousness
AdverseEvent.outcomerequiredOutcomeAEClinRes
AdverseEvent.suspectEntity.causality.assessmentMethodpreferredAdverseEventCausalityMethod
AdverseEvent.suspectEntity.causality.entityRelatednesspreferredCausalityRelatedness
AdverseEvent.supportingInfo.item[x]exampleAdverseEventSupportingInforation

Constraints

IdGradePath(s)DetailsRequirements
aeClinRes-seriousness-1errorAdverseEventIf seriousness is serious then must have at least one seriousness criterion.
: (seriousness.coding .exists(system='http://terminology.hl7.org/CodeSystem/adverse-event-seriousness' and code='serious') and extension('http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/seriousness-criteria').exists() and seriousness.coding .exists(system='http://terminology.hl7.org/CodeSystem/adverse-event-seriousness' and code='non-serious').not() ) or (seriousness.coding.exists(system='http://terminology.hl7.org/CodeSystem/adverse-event-seriousness' and code='non-serious') and seriousness.coding .exists(system='http://terminology.hl7.org/CodeSystem/adverse-event-seriousness' and code='serious').not() and extension('http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/seriousness-criteria').exists().not() )

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AdverseEvent C0..*AdverseEventAn event that may be related to unintended effects on a patient or research participant
aeClinRes-seriousness-1: If seriousness is serious then must have at least one seriousness criterion.
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... seriousness-criteria 0..*(Complex)Criteria reviewed in determining serious adverse event
URL: http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/seriousness-criteria
... severity-or-grade 0..1CodeableConceptThe degree of something undesirable
URL: http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/severity-or-grade
Binding: AdverseEvent Severity or Grade Value Set (preferred)
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codein-progress | completed | entered-in-error | unknown
Binding: AdverseEventStatus (required): Codes identifying the lifecycle stage of an event.

... actuality ?!Σ1..1codeactual
Binding: AdverseEventActuality (required): Overall nature of the adverse event, e.g. real or potential.


Required Pattern: actual
... subject Σ1..1Reference(Patient | Group | Practitioner | RelatedPerson | ResearchSubject)Subject impacted by event
... occurrence[x] SΣ0..1PeriodWhen the event occurred
... resultingEffect Σ0..*Reference(Condition | Observation)Effect on the subject due to this event
... seriousness SΣ1..1CodeableConceptInvestigator defined severity of the adverse event, in relation to the subject not the resulting condition
Binding: AdverseEventSeriousness (required)
... outcome SΣ1..1CodeableConceptType of outcome from the adverse event
Binding: Adverse Event Clinical Research Outcomes (required)
... study SΣ1..1Reference(ResearchStudy)Research study that the subject is enrolled in
... suspectEntity Σ0..*BackboneElementThe suspected agent causing the adverse event
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... instance[x] Σ1..1Refers to the specific entity that caused the adverse event
..... instanceCodeableConceptCodeableConcept
..... instanceReferenceReference(Immunization | Procedure | Substance | Medication | MedicationAdministration | MedicationStatement | Device | BiologicallyDerivedProduct | ResearchStudy)
.... causality SΣ1..1BackboneElementInformation on the possible cause of the event
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... assessmentMethod Σ0..1CodeableConceptMethod of evaluating the relatedness of the suspected entity to the event.
Binding: AdverseEventCausalityMethod (preferred): Codes for the method of evaluating the relatedness of the suspected entity to the event, such as ProbabilityScale | Bayesian | Checklist.

..... entityRelatedness Σ0..1CodeableConceptResult of the assessment regarding the relatedness of the suspected entity to the event
Binding: Causality Relatedness values (preferred)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
AdverseEvent.statusrequiredAdverseEventStatus
AdverseEvent.actualityrequiredPattern: actual
AdverseEvent.seriousnessrequiredAdverseEventSeriousness
AdverseEvent.outcomerequiredOutcomeAEClinRes
AdverseEvent.suspectEntity.causality.assessmentMethodpreferredAdverseEventCausalityMethod
AdverseEvent.suspectEntity.causality.entityRelatednesspreferredCausalityRelatedness
AdverseEvent.preventiveAction.item[x]exampleAdverseEventPreventiveAction

Constraints

IdGradePath(s)DetailsRequirements
aeClinRes-seriousness-1errorAdverseEventIf seriousness is serious then must have at least one seriousness criterion.
: (seriousness.coding .exists(system='http://terminology.hl7.org/CodeSystem/adverse-event-seriousness' and code='serious') and extension('http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/seriousness-criteria').exists() and seriousness.coding .exists(system='http://terminology.hl7.org/CodeSystem/adverse-event-seriousness' and code='non-serious').not() ) or (seriousness.coding.exists(system='http://terminology.hl7.org/CodeSystem/adverse-event-seriousness' and code='non-serious') and seriousness.coding .exists(system='http://terminology.hl7.org/CodeSystem/adverse-event-seriousness' and code='serious').not() and extension('http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/seriousness-criteria').exists().not() )
dom-2errorAdverseEventIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAdverseEventIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorAdverseEventIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorAdverseEventIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAdverseEventA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AdverseEvent C0..*AdverseEventAn event that may be related to unintended effects on a patient or research participant
aeClinRes-seriousness-1: If seriousness is serious then must have at least one seriousness criterion.
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... caused-subject-to-discontinue-study 0..1booleanAdverse event caused subject to discontinue the study
URL: http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/caused-subject-to-discontinue-study
... seriousness-criteria 0..*(Complex)Criteria reviewed in determining serious adverse event
URL: http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/seriousness-criteria
... severity-or-grade 0..1CodeableConceptThe degree of something undesirable
URL: http://hl7.org/fhir/uv/ae-research-ig/StructureDefinition/severity-or-grade
Binding: AdverseEvent Severity or Grade Value Set (preferred)
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier for the event
... status ?!Σ1..1codein-progress | completed | entered-in-error | unknown
Binding: AdverseEventStatus (required): Codes identifying the lifecycle stage of an event.

... actuality ?!Σ1..1codeactual
Binding: AdverseEventActuality (required): Overall nature of the adverse event, e.g. real or potential.


Required Pattern: actual
... category Σ0..*CodeableConceptwrong-patient | procedure-mishap | medication-mishap | device | unsafe-physical-environment | hospital-aquired-infection | wrong-body-site
Binding: AdverseEventCategory (example): Overall categorization of the event, e.g. product-related or situational.


... code Σ0..1CodeableConceptEvent or incident that occurred or was averted
Binding: AdverseEventType (example): Detailed type of event.

... subject Σ1..1Reference(Patient | Group | Practitioner | RelatedPerson | ResearchSubject)Subject impacted by event
... encounter Σ0..1Reference(Encounter)The Encounter associated with the start of the AdverseEvent
... occurrence[x] SΣ0..1PeriodWhen the event occurred
... detected Σ0..1dateTimeWhen the event was detected
... recordedDate Σ0..1dateTimeWhen the event was recorded
... resultingEffect Σ0..*Reference(Condition | Observation)Effect on the subject due to this event
... location Σ0..1Reference(Location)Location where adverse event occurred
... seriousness SΣ1..1CodeableConceptInvestigator defined severity of the adverse event, in relation to the subject not the resulting condition
Binding: AdverseEventSeriousness (required)
... outcome SΣ1..1CodeableConceptType of outcome from the adverse event
Binding: Adverse Event Clinical Research Outcomes (required)
... recorder Σ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | ResearchSubject)Who recorded the adverse event
... participant Σ0..*BackboneElementWho was involved in the adverse event or the potential adverse event and what they did
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... function Σ0..1CodeableConceptType of involvement
Binding: AdverseEventParticipantFunction (example): Codes describing the type of involvement of the actor in the adverse event.

.... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | ResearchSubject)Who was involved in the adverse event or the potential adverse event
... study SΣ1..1Reference(ResearchStudy)Research study that the subject is enrolled in
... expectedInResearchStudy 0..1booleanConsidered likely or probable or anticipated in the research study
... suspectEntity Σ0..*BackboneElementThe suspected agent causing the adverse event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... instance[x] Σ1..1Refers to the specific entity that caused the adverse event
..... instanceCodeableConceptCodeableConcept
..... instanceReferenceReference(Immunization | Procedure | Substance | Medication | MedicationAdministration | MedicationStatement | Device | BiologicallyDerivedProduct | ResearchStudy)
.... causality SΣ1..1BackboneElementInformation on the possible cause of the event
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... assessmentMethod Σ0..1CodeableConceptMethod of evaluating the relatedness of the suspected entity to the event.
Binding: AdverseEventCausalityMethod (preferred): Codes for the method of evaluating the relatedness of the suspected entity to the event, such as ProbabilityScale | Bayesian | Checklist.

..... entityRelatedness Σ0..1CodeableConceptResult of the assessment regarding the relatedness of the suspected entity to the event
Binding: Causality Relatedness values (preferred)
..... author Σ0..1Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | ResearchSubject)Author of the information on the possible cause of the event
... contributingFactor Σ0..*BackboneElementContributing factors suspected to have increased the probability or severity of the adverse event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] Σ1..1Item suspected to have increased the probability or severity of the adverse event
Binding: AdverseEventContributingFactor (example): Codes describing the contributing factors suspected to have increased the probability or severity of the adverse event.

..... itemReferenceReference(Condition | Observation | AllergyIntolerance | FamilyMemberHistory | Immunization | Procedure | Device | DeviceUsage | DocumentReference | MedicationAdministration | MedicationStatement)
..... itemCodeableConceptCodeableConcept
... mitigatingAction Σ0..*BackboneElementAmeliorating actions taken after the adverse event occured in order to reduce the extent of harm
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] Σ1..1Ameliorating action taken after the adverse event occured in order to reduce the extent of harm
Binding: AdverseEventMitigatingAction (example): Codes describing the ameliorating actions taken after the adverse event occured in order to reduce the extent of harm.

..... itemReferenceReference(Procedure | DocumentReference | MedicationAdministration | MedicationRequest)
..... itemCodeableConceptCodeableConcept
... supportingInfo Σ0..*BackboneElementSupporting information relevant to the event
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... item[x] Σ1..1Subject medical history or document relevant to this adverse event
Binding: AdverseEventSupportingInforation (example): Codes describing the supporting information relevant to the event.

..... itemReferenceReference(Condition | Observation | AllergyIntolerance | FamilyMemberHistory | Immunization | Procedure | DocumentReference | MedicationAdministration | MedicationStatement | QuestionnaireResponse)
..... itemCodeableConceptCodeableConcept
... note Σ0..*AnnotationComment on adverse event

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
AdverseEvent.languagerequiredAllLanguages
AdverseEvent.statusrequiredAdverseEventStatus
AdverseEvent.actualityrequiredPattern: actual
AdverseEvent.categoryexampleAdverseEventCategory
AdverseEvent.codeexampleAdverseEventType
AdverseEvent.seriousnessrequiredAdverseEventSeriousness
AdverseEvent.outcomerequiredOutcomeAEClinRes
AdverseEvent.participant.functionexampleAdverseEventParticipantFunction
AdverseEvent.suspectEntity.causality.assessmentMethodpreferredAdverseEventCausalityMethod
AdverseEvent.suspectEntity.causality.entityRelatednesspreferredCausalityRelatedness
AdverseEvent.contributingFactor.item[x]exampleAdverseEventContributingFactor
AdverseEvent.preventiveAction.item[x]exampleAdverseEventPreventiveAction
AdverseEvent.mitigatingAction.item[x]exampleAdverseEventMitigatingAction
AdverseEvent.supportingInfo.item[x]exampleAdverseEventSupportingInforation

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from AdverseEvent

 

Other representations of profile: CSV, Excel, Schematron