AdverseEvent

The AdverseEvent FHIR resource is for immunization AEFI

idΣ1..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileΣ1..1canonical(StructureDefinition)
securityΣ0..1CodingBinding
tagΣ0..1Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..1Resource
id0..0string
id0..0string
extensionI0..*Extension
url1..1uriFixed Value
id0..0string
extensionI0..*Extension
timeΣ0..0dateTime
textΣ1..1markdown
id0..0string
extensionI0..*Extension
url1..1uriFixed Value
valueDateTimedateTime
id0..0string
extensionI0..*Extension
url1..1uriFixed Value
valueStringstring
url1..1uriFixed Value
modifierExtension?! I0..*Extension
id0..0string
extensionI0..*Extension
useΣ ?!0..0codeBinding
id0..0string
extensionI0..*Extension
codingΣ0..0Coding
textΣ1..1string
systemΣ1..1uri
valueΣ1..1string
periodΣ0..0Period
assignerΣ0..0Reference(Organization)
id0..1string
id0..0string
id0..0string
extensionI0..*Extension
url1..1uriFixed Value
id0..0string
extensionI0..*Extension
id0..0string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..0string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..0boolean
textΣ0..0string
id0..0string
extensionI0..*Extension
url1..1uriFixed Value
valueStringstring
id0..0string
extensionI0..*Extension
url1..1uriFixed Value
valueStringstring
url1..1uriFixed Value
value0..1System.String
categoryΣ0..1CodeableConceptBinding
eventΣ0..1CodeableConcept
id0..0string
extensionI0..*Extension
referenceΣ I1..1string
typeΣ0..0uriBinding
identifierΣ0..0Identifier
displayΣ0..0string
encounterΣ0..1Reference(Encounter)
dateΣ0..1dateTime
detectedΣ0..1dateTime
recordedDateΣ1..1dateTime
resultingConditionΣ0..1Reference(Condition)
locationΣ0..1Reference(Location)
seriousnessΣ0..1CodeableConcept
severityΣ0..1CodeableConceptBinding
outcomeΣ0..1CodeableConceptBinding
recorderΣ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)
contributorΣ0..1Reference(Practitioner | PractitionerRole | Device)
id0..0string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..0string
extensionI0..*Extension
referenceΣ I1..1string
typeΣ0..0uriBinding
identifierΣ0..0Identifier
displayΣ0..0string
subjectMedicalHistoryΣ0..1Reference(Condition | Observation | AllergyIntolerance | FamilyMemberHistory | Immunization | Procedure | Media | DocumentReference)
referenceDocumentΣ0..1Reference(DocumentReference)
studyΣ0..1Reference(ResearchStudy)
AdverseEvent
DefinitionFHIR resource applies for PIR AEFI
Cardinality0...*
AliasAE
Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-3: If 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-4: If 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-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
Mappings
  • rim: Entity. Role, or Act
AdverseEvent.id
DefinitionPIR Internal AEFI Identifier
Cardinality1...1
Typestring
SummaryTrue
Comments

See Mappings

Mappings
  • source-PIR: IMMS.ADVERSE_EVENT.ADVERSE_EVENT_ID
  • source-PHSL: adverseEventId
AdverseEvent.meta
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.
Cardinality1...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.meta.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
AdverseEvent.meta.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
AdverseEvent.meta.versionId
DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Cardinality0...1
Typeid
SummaryTrue
Comments

Apply "2025.01.1". This indicates the FHIR Specs as of year 2025 January.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.meta.lastUpdated
DefinitionWhen the resource last changed - e.g. when the version changed.
Cardinality0...1
Typeinstant
SummaryTrue
Comments

Updated: Relax the previously crossed-out elements.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.meta.source
DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
Cardinality0...1
Typeuri
SummaryTrue
Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.meta.profile
DefinitionA list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).
Cardinality1...1
Typecanonical(StructureDefinition)
SummaryTrue
Comments

Apply "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/AdverseEvent"

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.meta.security
DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Cardinality0...1
TypeCoding
Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)
SummaryTrue
Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.meta.tag
DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
Cardinality0...1
TypeCoding
Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)
SummaryTrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.implicitRules
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.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.text
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.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
AdverseEvent.contained
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.
Cardinality0...1
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: N/A
AdverseEvent.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
AdverseEvent.extension:AEFIpublicHealthRecomm
DefinitionPublic Health Recommendation(s) for AEFI
Cardinality0...*
TypeExtension(Complex)
Aliasextensions, user content
Comments

Version 2024.4: Send DateTime for element phrDate.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
  • rim: n/a
AdverseEvent.extension:AEFIpublicHealthRecomm.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
AdverseEvent.extension:AEFIpublicHealthRecomm.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrRecommendations
DefinitionAEFI Public Health Recommendations
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • source-PIR: NOCHANGE_CD_CNCPT_ID
  • source-PHSL: pubHealthRecomm
AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrRecommendations.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrRecommendations.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrRecommendations.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

phrRecommendations

Mappings
  • rim: N/A
AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrRecommendations.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
TypeAnnotation
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrRecommendations.value[x].id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrRecommendations.value[x].extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrRecommendations.value[x].author[x]
DefinitionThe individual responsible for making the annotation.
Cardinality0...0
TypeReference(Practitioner | Patient | RelatedPerson | Organization)
SummaryTrue
Comments

Organization is used when there's no need for specific attribution as to who made the comment.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.participant[typeCode=AUT].role
AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrRecommendations.value[x].time
DefinitionIndicates when this particular annotation was made.
Cardinality0...0
TypedateTime
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.effectiveTime
AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrRecommendations.value[x].text
DefinitionThe text of the annotation in markdown format.
Cardinality1...1
Typemarkdown
SummaryTrue
Comments

NOCHANGE_CD_CNCPT_ID EXPERTREF_CD_CNCPT_ID DETPROTANT_CD_CNCPT_ID CONTROLSETIMM_CD_CNCPT_ID NOFURTHER_CD_CNCPT_ID OTHER_CD_CNCPT_ID ACTIVEFOLLOWUP_CD_CNCPT_ID NOTHING_CD_CNCPT_ID

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.text
AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrDate
DefinitionAEFI Public Health Recommendations Date
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • source-PIR: REPORTNG.AE_EVENT_RECOMMENDATION.CREATED_ON
  • source-PHSL: pubDate
AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrDate.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrDate.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrDate.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

phrDate

Mappings
  • rim: N/A
AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrDate.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
TypedateTime
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
  • source-PIR: REPORTNG.AE_EVENT_RECOMMENDATION.CREATED_ON
AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrComment
DefinitionAEFI Public Health Recommendations Comments
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • source-PIR: IMMUNIZATION_COMMENT.COMMENT_TEXT
  • source-PHSL: phrComment
AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrComment.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrComment.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrComment.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

phrComment

Mappings
  • rim: N/A
AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrComment.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
Typestring
Comments

See Mappings. Only applies to adverse event recommendation comment types, i.e.,where reportng.ae_event_recommendation.ae_event_recommendation_id = immunization_comment.row_id AND comment_type = 'AE' AND comment_subtype = 'RECOMM'

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
  • source-PIR: IMMUNIZATION_COMMENT.COMMENT_TEXT
AdverseEvent.extension:AEFIpublicHealthRecomm.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/AEFI-publicHealth-recomm

Mappings
  • rim: N/A
AdverseEvent.extension:AEFIpublicHealthRecomm.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...0
Typebase64Binary
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
AdverseEvent.modifierExtension
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).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

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.

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
AdverseEvent.identifier
DefinitionPIR Internal AEFI ID + External AEFI ID from source system(s)
Cardinality1...1
TypeIdentifier
SummaryTrue
Requirements

Allows identification of the adverse event as it is known by various participating systems and in a way that remains consistent across servers.

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.identifier.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
AdverseEvent.identifier.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
AdverseEvent.identifier.use
DefinitionThe purpose of this identifier.
Cardinality0...0
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)
ModifierTrue
SummaryTrue
Requirements

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

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
AdverseEvent.identifier.type
DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality1...1
TypeCodeableConcept
Binding

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

Identifier Type Codes (extensible)
SummaryTrue
Requirements

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

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
AdverseEvent.identifier.type.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
AdverseEvent.identifier.type.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
AdverseEvent.identifier.type.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality0...0
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
AdverseEvent.identifier.type.text
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.
Cardinality1...1
Typestring
SummaryTrue
Requirements

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

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
  • source-PIR: PANORAMAIMMZAEFIID
AdverseEvent.identifier.system
DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality1...1
Typeuri
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

http://www.acme.com/identifiers/patient


Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
  • source-PIR: https://health.gov.bc.ca/fhir/NamingSystem/ca-bc-panorama-immunization-AEFI-id
AdverseEvent.identifier.value
DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality1...1
Typestring
SummaryTrue
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

123456


Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
  • source-PIR: IMMS.ADVERSE_EVENT.ADVERSE_EVENT_ID
  • source-PHSL: adverseEventId
AdverseEvent.identifier.period
DefinitionTime period during which identifier is/was valid for use.
Cardinality0...0
TypePeriod
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
AdverseEvent.identifier.assigner
DefinitionOrganization that issued/manages the identifier.
Cardinality0...0
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
AdverseEvent.actuality
DefinitionWhether the event actually happened, or just had the potential to.
Cardinality1...1
Typecode
Binding

Overall nature of the adverse event, e.g. real or potential.

AdverseEventActuality (required)
ModifierTrue
SummaryTrue
Comments

Apply "actual" for PIR.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
AdverseEvent.actuality.id
Definitionunique id for the element within a resource (for internal references)
Cardinality0...1
Typestring
AdverseEvent.actuality.extension
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.
Cardinality1...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
AdverseEvent.actuality.extension:_actuality
DefinitionOptional Extension Element - found in all resources.
Cardinality1...1
TypeExtension(Complex)
Aliasextensions, user content
Comments

To apply for AEFI status and delete reason

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
AdverseEvent.actuality.extension:_actuality.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
AdverseEvent.actuality.extension:_actuality.extension
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.
Cardinality1...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus
DefinitionAEFI Status
Cardinality1...1
TypeExtension
Aliasextensions, user content
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

AEFIstatus

Mappings
  • rim: N/A
AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
TypeCodeableConcept
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.value[x].id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.value[x].extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.value[x].coding
DefinitionA reference to a code defined by a terminology system.
Cardinality1...1
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.value[x].coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.value[x].coding.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.value[x].coding.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality1...1
Typeuri
SummaryTrue
Requirements

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

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
  • source-PIR: https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code
AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.value[x].coding.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...0
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.value[x].coding.code
DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality1...1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
  • source-PIR: ADVERSE_EVENT.STATUS_CODED_CNCPT_ID
  • source-PHSL: status
AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.value[x].coding.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...1
Typestring
SummaryTrue
Requirements

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

Comments

See MAppings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
  • source-PIR: ADVERSE_EVENT.STATUS_CODED_CNCPT_ID
  • source-PHSL: statusDescription
AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.value[x].coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...0
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.value[x].text
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.
Cardinality0...0
Typestring
SummaryTrue
Requirements

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
AdverseEvent.actuality.extension:_actuality.extension:AEFIdeleteReason
DefinitionAEFI deleted reason
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

To be apply when AEFI has status = Disregard, Entered in Error or NO reason provided. See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • source-PIR-nullReason: Other
AdverseEvent.actuality.extension:_actuality.extension:AEFIdeleteReason.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
AdverseEvent.actuality.extension:_actuality.extension:AEFIdeleteReason.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
AdverseEvent.actuality.extension:_actuality.extension:AEFIdeleteReason.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

AEFIdeleteReason

Mappings
  • rim: N/A
AdverseEvent.actuality.extension:_actuality.extension:AEFIdeleteReason.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
Typestring
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
AdverseEvent.actuality.extension:_actuality.extension:AEFIdeleteReasonOther
DefinitionAEFI deleted reason = Other, specify
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

To be apply when AEFI status has OTHER reason or NO reason provided. See Mappings.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • source-PIR-null: unknown
AdverseEvent.actuality.extension:_actuality.extension:AEFIdeleteReasonOther.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
AdverseEvent.actuality.extension:_actuality.extension:AEFIdeleteReasonOther.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
AdverseEvent.actuality.extension:_actuality.extension:AEFIdeleteReasonOther.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

AEFIdeleteReasonOther

Mappings
  • rim: N/A
AdverseEvent.actuality.extension:_actuality.extension:AEFIdeleteReasonOther.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
Typestring
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
AdverseEvent.actuality.extension:_actuality.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/AEFI-status-reason

Mappings
  • rim: N/A
AdverseEvent.actuality.extension:_actuality.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...0
Typebase64Binary
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
AdverseEvent.actuality.value
DefinitionPrimitive value for code
Cardinality0...1
TypeSystem.String
AdverseEvent.category
DefinitionThe overall type of event, intended for search and filtering purposes.
Cardinality0...1
TypeCodeableConcept
Binding

Overall categorization of the event, e.g. product-related or situational.

AdverseEventCategory (extensible)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
AdverseEvent.event
DefinitionThis element defines the specific type of event that occurred or that was prevented from occurring.
Cardinality0...1
TypeCodeableConcept
Binding

Detailed type of event.

SNOMEDCTClinicalFindings (example)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.what[x]
AdverseEvent.subject
DefinitionThis subject or group impacted by the event.
Cardinality1...1
TypeReference(Patient | Group | Practitioner | RelatedPerson)
SummaryTrue
Aliaspatient
Requirements

Allows for exposure of biohazard (such as legionella) to a group of individuals in a hospital.

Comments

If AdverseEvent.resultingCondition differs among members of the group, then use Patient as the subject.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.who
AdverseEvent.subject.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
AdverseEvent.subject.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
AdverseEvent.subject.reference
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.
Cardinality1...1
Typestring
SummaryTrue
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
  • source-PIR: fullURL of Panorama + "Patient" + PIR Client ID
AdverseEvent.subject.type
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).
Cardinality0...0
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
AdverseEvent.subject.identifier
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.
Cardinality0...0
TypeIdentifier
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
AdverseEvent.subject.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...0
Typestring
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
AdverseEvent.encounter
DefinitionThe Encounter during which AdverseEvent was created or to which the creation of this record is tightly associated.
Cardinality0...1
TypeReference(Encounter)
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.context
AdverseEvent.date
DefinitionThe date (and perhaps time) when the adverse event occurred.
Cardinality0...1
TypedateTime
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.init
AdverseEvent.detected
DefinitionEstimated or actual date the AdverseEvent began, in the opinion of the reporter.
Cardinality0...1
TypedateTime
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.recordedDate
DefinitionThe date on which the existence of the AdverseEvent was first recorded.
Cardinality1...1
TypedateTime
SummaryTrue
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.recorded
  • source-PIR: IMMS.ADVERSE_EVENT.DATE_REPORTED
  • source-PHSL: dateReported
AdverseEvent.resultingCondition
DefinitionIncludes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).
Cardinality0...1
TypeReference(Condition)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.location
DefinitionThe information about where the adverse event occurred.
Cardinality0...1
TypeReference(Location)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.seriousness
DefinitionAssessment whether this event was of real importance.
Cardinality0...1
TypeCodeableConcept
Binding

Overall seriousness of this event for the patient.

AdverseEventSeriousness (example)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.severity
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.
Cardinality0...1
TypeCodeableConcept
Binding

The severity of the adverse event itself, in direct relation to the subject.

AdverseEventSeverity (required)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.outcome
DefinitionDescribes the type of outcome from the adverse event.
Cardinality0...1
TypeCodeableConcept
Binding

TODO (and should this be required?).

AdverseEventOutcome (required)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.recorder
DefinitionInformation on who recorded the adverse event. May be the patient or a practitioner.
Cardinality0...1
TypeReference(Patient | Practitioner | PractitionerRole | RelatedPerson)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.author
AdverseEvent.contributor
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).
Cardinality0...1
TypeReference(Practitioner | PractitionerRole | Device)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.suspectEntity
DefinitionDescribes the vaccine that is suspected to have caused the adverse event.
Cardinality1...*
TypeBackboneElement
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.suspectEntity.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Comments

Apply PIR: IMMS.AE_VACCINATION.IMMUNIZATION_ID

Mappings
  • rim: n/a
AdverseEvent.suspectEntity.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
AdverseEvent.suspectEntity.modifierExtension
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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

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.

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
AdverseEvent.suspectEntity.instance
DefinitionIdentifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device.
Cardinality1...1
TypeReference(Immunization | Procedure | Substance | Medication | MedicationAdministration | MedicationStatement | Device)
SummaryTrue
AliasSubstance or Medication or Device
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.suspectEntity.instance.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
AdverseEvent.suspectEntity.instance.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
AdverseEvent.suspectEntity.instance.reference
DefinitionReference the resourceImmunization with the AEFI vaccine
Cardinality1...1
Typestring
SummaryTrue
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
  • source-PIR: fullURL of Panorama + 'Immunization' + (PIR Imms ID)
  • source-PHSL: adverseEventAssociatedImmsId
AdverseEvent.suspectEntity.instance.type
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).
Cardinality0...0
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
AdverseEvent.suspectEntity.instance.identifier
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.
Cardinality0...0
TypeIdentifier
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
AdverseEvent.suspectEntity.instance.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...0
Typestring
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
AdverseEvent.suspectEntity.causality
DefinitionInformation on the possible cause of the event.
Cardinality0...0
TypeBackboneElement
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.suspectEntity.causality.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
AdverseEvent.suspectEntity.causality.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
AdverseEvent.suspectEntity.causality.modifierExtension
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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

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.

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
AdverseEvent.suspectEntity.causality.assessment
DefinitionAssessment of if the entity caused the event.
Cardinality0...1
TypeCodeableConcept
Binding

Codes for the assessment of whether the entity caused the event.

AdverseEventCausalityAssessment (example)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.suspectEntity.causality.productRelatedness
DefinitionAdverseEvent.suspectEntity.causalityProductRelatedness.
Cardinality0...1
Typestring
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.suspectEntity.causality.author
DefinitionAdverseEvent.suspectEntity.causalityAuthor.
Cardinality0...1
TypeReference(Practitioner | PractitionerRole)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.suspectEntity.causality.method
DefinitionProbabilityScale | Bayesian | Checklist.
Cardinality0...1
TypeCodeableConcept
Binding

TODO.

AdverseEventCausalityMethod (example)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.subjectMedicalHistory
DefinitionAdverseEvent.subjectMedicalHistory.
Cardinality0...1
TypeReference(Condition | Observation | AllergyIntolerance | FamilyMemberHistory | Immunization | Procedure | Media | DocumentReference)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.referenceDocument
DefinitionAdverseEvent.referenceDocument.
Cardinality0...1
TypeReference(DocumentReference)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
AdverseEvent.study
DefinitionAdverseEvent.study.
Cardinality0...1
TypeReference(ResearchStudy)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
<StructureDefinition xmlns="http://hl7.org/fhir">
    <url value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/AdverseEvent" />
    <name value="AdverseEvent" />
    <status value="draft" />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="AdverseEvent" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/AdverseEvent" />
    <derivation value="constraint" />
    <differential>
        <element id="AdverseEvent">
            <path value="AdverseEvent" />
            <short value="FHIR resource applies for PIR AEFI" />
            <definition value="FHIR resource applies for PIR AEFI" />
        </element>
        <element id="AdverseEvent.id">
            <path value="AdverseEvent.id" />
            <short value="PIR Internal AEFI ID" />
            <definition value="PIR Internal AEFI Identifier" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="IMMS.ADVERSE_EVENT.ADVERSE_EVENT_ID" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="adverseEventId" />
            </mapping>
        </element>
        <element id="AdverseEvent.meta">
            <path value="AdverseEvent.meta" />
            <min value="1" />
        </element>
        <element id="AdverseEvent.meta.versionId">
            <path value="AdverseEvent.meta.versionId" />
            <comment value="Apply &quot;2025.01.1&quot;.  This indicates the FHIR Specs as of year 2025 January." />
        </element>
        <element id="AdverseEvent.meta.lastUpdated">
            <path value="AdverseEvent.meta.lastUpdated" />
            <comment value="Updated: Relax the previously crossed-out elements." />
        </element>
        <element id="AdverseEvent.meta.profile">
            <path value="AdverseEvent.meta.profile" />
            <comment value="Apply &quot;http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/AdverseEvent&quot;" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="AdverseEvent.meta.security">
            <path value="AdverseEvent.meta.security" />
            <max value="1" />
        </element>
        <element id="AdverseEvent.meta.tag">
            <path value="AdverseEvent.meta.tag" />
            <max value="1" />
        </element>
        <element id="AdverseEvent.contained">
            <path value="AdverseEvent.contained" />
            <max value="1" />
        </element>
        <element id="AdverseEvent.extension:AEFIpublicHealthRecomm">
            <path value="AdverseEvent.extension" />
            <sliceName value="AEFIpublicHealthRecomm" />
            <short value="Public Health Recommendation(s) for AEFI" />
            <definition value="Public Health Recommendation(s) for AEFI" />
            <type>
                <code value="Extension" />
                <profile value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/AEFI-publicHealth-recomm" />
            </type>
        </element>
        <element id="AdverseEvent.extension:AEFIpublicHealthRecomm.id">
            <path value="AdverseEvent.extension.id" />
            <max value="0" />
        </element>
        <element id="AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrRecommendations">
            <path value="AdverseEvent.extension.extension" />
            <sliceName value="phrRecommendations" />
            <mapping>
                <identity value="source-PIR" />
                <map value="NOCHANGE_CD_CNCPT_ID" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="pubHealthRecomm" />
            </mapping>
        </element>
        <element id="AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrDate">
            <path value="AdverseEvent.extension.extension" />
            <sliceName value="phrDate" />
            <comment value="See Mappings" />
            <mapping>
                <identity value="source-PIR" />
                <map value="REPORTNG.AE_EVENT_RECOMMENDATION.CREATED_ON" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="pubDate" />
            </mapping>
        </element>
        <element id="AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrComment">
            <path value="AdverseEvent.extension.extension" />
            <sliceName value="phrComment" />
            <comment value="See Mappings" />
            <mapping>
                <identity value="source-PIR" />
                <map value="IMMUNIZATION_COMMENT.COMMENT_TEXT" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="phrComment" />
            </mapping>
        </element>
        <element id="AdverseEvent.identifier">
            <path value="AdverseEvent.identifier" />
            <short value="PIR Internal AEFI ID + External AEFI ID from source system(s)" />
            <definition value="PIR Internal AEFI ID + External AEFI ID from source system(s)" />
            <min value="1" />
        </element>
        <element id="AdverseEvent.identifier.id">
            <path value="AdverseEvent.identifier.id" />
            <max value="0" />
        </element>
        <element id="AdverseEvent.identifier.use">
            <path value="AdverseEvent.identifier.use" />
            <max value="0" />
        </element>
        <element id="AdverseEvent.identifier.type">
            <path value="AdverseEvent.identifier.type" />
            <min value="1" />
        </element>
        <element id="AdverseEvent.identifier.type.id">
            <path value="AdverseEvent.identifier.type.id" />
            <max value="0" />
        </element>
        <element id="AdverseEvent.identifier.type.coding">
            <path value="AdverseEvent.identifier.type.coding" />
            <max value="0" />
        </element>
        <element id="AdverseEvent.identifier.type.text">
            <path value="AdverseEvent.identifier.type.text" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="PANORAMAIMMZAEFIID" />
            </mapping>
        </element>
        <element id="AdverseEvent.identifier.system">
            <path value="AdverseEvent.identifier.system" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="https://health.gov.bc.ca/fhir/NamingSystem/ca-bc-panorama-immunization-AEFI-id" />
            </mapping>
        </element>
        <element id="AdverseEvent.identifier.value">
            <path value="AdverseEvent.identifier.value" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="IMMS.ADVERSE_EVENT.ADVERSE_EVENT_ID" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="adverseEventId" />
            </mapping>
        </element>
        <element id="AdverseEvent.identifier.period">
            <path value="AdverseEvent.identifier.period" />
            <max value="0" />
        </element>
        <element id="AdverseEvent.identifier.assigner">
            <path value="AdverseEvent.identifier.assigner" />
            <max value="0" />
        </element>
        <element id="AdverseEvent.actuality">
            <path value="AdverseEvent.actuality" />
            <definition value="Whether the event actually happened, or just had the potential to." />
            <comment value="Apply &quot;actual&quot; for PIR." />
        </element>
        <element id="AdverseEvent.actuality.extension">
            <path value="AdverseEvent.actuality.extension" />
            <min value="1" />
        </element>
        <element id="AdverseEvent.actuality.extension:_actuality">
            <path value="AdverseEvent.actuality.extension" />
            <sliceName value="_actuality" />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/AEFI-status-reason" />
            </type>
            <isModifier value="false" />
        </element>
        <element id="AdverseEvent.actuality.extension:_actuality.extension">
            <path value="AdverseEvent.actuality.extension.extension" />
            <min value="1" />
        </element>
        <element id="AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus">
            <path value="AdverseEvent.actuality.extension.extension" />
            <sliceName value="AEFIstatus" />
            <short value="AEFI Status" />
            <definition value="AEFI Status" />
            <min value="1" />
        </element>
        <element id="AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.value[x]">
            <path value="AdverseEvent.actuality.extension.extension.value[x]" />
        </element>
        <element id="AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.value[x].coding">
            <path value="AdverseEvent.actuality.extension.extension.value[x].coding" />
        </element>
        <element id="AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.value[x].coding.code">
            <path value="AdverseEvent.actuality.extension.extension.value[x].coding.code" />
            <comment value="See Mappings" />
            <mapping>
                <identity value="source-PIR" />
                <map value="ADVERSE_EVENT.STATUS_CODED_CNCPT_ID" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="status" />
            </mapping>
        </element>
        <element id="AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.value[x].coding.display">
            <path value="AdverseEvent.actuality.extension.extension.value[x].coding.display" />
            <comment value="See MAppings" />
            <mapping>
                <identity value="source-PIR" />
                <map value="ADVERSE_EVENT.STATUS_CODED_CNCPT_ID" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="statusDescription" />
            </mapping>
        </element>
        <element id="AdverseEvent.actuality.extension:_actuality.extension:AEFIdeleteReason">
            <path value="AdverseEvent.actuality.extension.extension" />
            <sliceName value="AEFIdeleteReason" />
            <short value="AEFI deleted reason" />
            <definition value="AEFI deleted reason" />
            <comment value="To be apply when AEFI has status = Disregard, Entered in Error or NO reason provided.  See Mappings" />
            <mapping>
                <identity value="source-PIR-nullReason" />
                <map value="Other" />
            </mapping>
        </element>
        <element id="AdverseEvent.actuality.extension:_actuality.extension:AEFIdeleteReasonOther">
            <path value="AdverseEvent.actuality.extension.extension" />
            <sliceName value="AEFIdeleteReasonOther" />
            <short value="AEFI deleted reason = Other, specify" />
            <definition value="AEFI deleted reason = Other, specify" />
            <comment value="To be apply when AEFI status has OTHER reason or NO reason provided.  See Mappings." />
            <mapping>
                <identity value="source-PIR-null" />
                <map value="unknown" />
            </mapping>
        </element>
        <element id="AdverseEvent.category">
            <path value="AdverseEvent.category" />
            <max value="1" />
        </element>
        <element id="AdverseEvent.subject.id">
            <path value="AdverseEvent.subject.id" />
            <max value="0" />
        </element>
        <element id="AdverseEvent.subject.reference">
            <path value="AdverseEvent.subject.reference" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="fullURL of Panorama + &quot;Patient&quot; + PIR Client ID" />
            </mapping>
        </element>
        <element id="AdverseEvent.subject.type">
            <path value="AdverseEvent.subject.type" />
            <max value="0" />
        </element>
        <element id="AdverseEvent.subject.identifier">
            <path value="AdverseEvent.subject.identifier" />
            <max value="0" />
        </element>
        <element id="AdverseEvent.subject.display">
            <path value="AdverseEvent.subject.display" />
            <max value="0" />
        </element>
        <element id="AdverseEvent.recordedDate">
            <path value="AdverseEvent.recordedDate" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="IMMS.ADVERSE_EVENT.DATE_REPORTED" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="dateReported" />
            </mapping>
        </element>
        <element id="AdverseEvent.resultingCondition">
            <path value="AdverseEvent.resultingCondition" />
            <max value="1" />
        </element>
        <element id="AdverseEvent.contributor">
            <path value="AdverseEvent.contributor" />
            <max value="1" />
        </element>
        <element id="AdverseEvent.suspectEntity">
            <path value="AdverseEvent.suspectEntity" />
            <definition value="Describes the vaccine that is suspected to have caused the adverse event." />
            <min value="1" />
        </element>
        <element id="AdverseEvent.suspectEntity.id">
            <path value="AdverseEvent.suspectEntity.id" />
            <comment value="Apply PIR: IMMS.AE_VACCINATION.IMMUNIZATION_ID" />
            <max value="0" />
        </element>
        <element id="AdverseEvent.suspectEntity.instance.id">
            <path value="AdverseEvent.suspectEntity.instance.id" />
            <max value="0" />
        </element>
        <element id="AdverseEvent.suspectEntity.instance.reference">
            <path value="AdverseEvent.suspectEntity.instance.reference" />
            <short value="Reference the resourceImmunization with the AEFI vaccine" />
            <definition value="Reference the resourceImmunization with the AEFI vaccine" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="fullURL of Panorama + &#39;Immunization&#39; + (PIR Imms ID)" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="adverseEventAssociatedImmsId" />
            </mapping>
        </element>
        <element id="AdverseEvent.suspectEntity.instance.type">
            <path value="AdverseEvent.suspectEntity.instance.type" />
            <max value="0" />
        </element>
        <element id="AdverseEvent.suspectEntity.instance.identifier">
            <path value="AdverseEvent.suspectEntity.instance.identifier" />
            <max value="0" />
        </element>
        <element id="AdverseEvent.suspectEntity.instance.display">
            <path value="AdverseEvent.suspectEntity.instance.display" />
            <max value="0" />
        </element>
        <element id="AdverseEvent.suspectEntity.causality">
            <path value="AdverseEvent.suspectEntity.causality" />
            <max value="0" />
        </element>
        <element id="AdverseEvent.subjectMedicalHistory">
            <path value="AdverseEvent.subjectMedicalHistory" />
            <max value="1" />
        </element>
        <element id="AdverseEvent.referenceDocument">
            <path value="AdverseEvent.referenceDocument" />
            <max value="1" />
        </element>
        <element id="AdverseEvent.study">
            <path value="AdverseEvent.study" />
            <max value="1" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/AdverseEvent",
    "name": "AdverseEvent",
    "status": "draft",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "AdverseEvent",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/AdverseEvent",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "AdverseEvent",
                "path": "AdverseEvent",
                "short": "FHIR resource applies for PIR AEFI",
                "definition": "FHIR resource applies for PIR AEFI"
            },
            {
                "id": "AdverseEvent.id",
                "path": "AdverseEvent.id",
                "short": "PIR Internal AEFI ID",
                "definition": "PIR Internal AEFI Identifier",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "IMMS.ADVERSE_EVENT.ADVERSE_EVENT_ID"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "adverseEventId"
                    }
                ]
            },
            {
                "id": "AdverseEvent.meta",
                "path": "AdverseEvent.meta",
                "min": 1
            },
            {
                "id": "AdverseEvent.meta.versionId",
                "path": "AdverseEvent.meta.versionId",
                "comment": "Apply \"2025.01.1\".  This indicates the FHIR Specs as of year 2025 January."
            },
            {
                "id": "AdverseEvent.meta.lastUpdated",
                "path": "AdverseEvent.meta.lastUpdated",
                "comment": "Updated: Relax the previously crossed-out elements."
            },
            {
                "id": "AdverseEvent.meta.profile",
                "path": "AdverseEvent.meta.profile",
                "comment": "Apply \"http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/AdverseEvent\"",
                "min": 1,
                "max": "1"
            },
            {
                "id": "AdverseEvent.meta.security",
                "path": "AdverseEvent.meta.security",
                "max": "1"
            },
            {
                "id": "AdverseEvent.meta.tag",
                "path": "AdverseEvent.meta.tag",
                "max": "1"
            },
            {
                "id": "AdverseEvent.contained",
                "path": "AdverseEvent.contained",
                "max": "1"
            },
            {
                "id": "AdverseEvent.extension:AEFIpublicHealthRecomm",
                "path": "AdverseEvent.extension",
                "sliceName": "AEFIpublicHealthRecomm",
                "short": "Public Health Recommendation(s) for AEFI",
                "definition": "Public Health Recommendation(s) for AEFI",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/AEFI-publicHealth-recomm"
                        ]
                    }
                ]
            },
            {
                "id": "AdverseEvent.extension:AEFIpublicHealthRecomm.id",
                "path": "AdverseEvent.extension.id",
                "max": "0"
            },
            {
                "id": "AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrRecommendations",
                "path": "AdverseEvent.extension.extension",
                "sliceName": "phrRecommendations",
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "NOCHANGE_CD_CNCPT_ID"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "pubHealthRecomm"
                    }
                ]
            },
            {
                "id": "AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrDate",
                "path": "AdverseEvent.extension.extension",
                "sliceName": "phrDate",
                "comment": "See Mappings",
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "REPORTNG.AE_EVENT_RECOMMENDATION.CREATED_ON"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "pubDate"
                    }
                ]
            },
            {
                "id": "AdverseEvent.extension:AEFIpublicHealthRecomm.extension:phrComment",
                "path": "AdverseEvent.extension.extension",
                "sliceName": "phrComment",
                "comment": "See Mappings",
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "IMMUNIZATION_COMMENT.COMMENT_TEXT"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "phrComment"
                    }
                ]
            },
            {
                "id": "AdverseEvent.identifier",
                "path": "AdverseEvent.identifier",
                "short": "PIR Internal AEFI ID + External AEFI ID from source system(s)",
                "definition": "PIR Internal AEFI ID + External AEFI ID from source system(s)",
                "min": 1
            },
            {
                "id": "AdverseEvent.identifier.id",
                "path": "AdverseEvent.identifier.id",
                "max": "0"
            },
            {
                "id": "AdverseEvent.identifier.use",
                "path": "AdverseEvent.identifier.use",
                "max": "0"
            },
            {
                "id": "AdverseEvent.identifier.type",
                "path": "AdverseEvent.identifier.type",
                "min": 1
            },
            {
                "id": "AdverseEvent.identifier.type.id",
                "path": "AdverseEvent.identifier.type.id",
                "max": "0"
            },
            {
                "id": "AdverseEvent.identifier.type.coding",
                "path": "AdverseEvent.identifier.type.coding",
                "max": "0"
            },
            {
                "id": "AdverseEvent.identifier.type.text",
                "path": "AdverseEvent.identifier.type.text",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "PANORAMAIMMZAEFIID"
                    }
                ]
            },
            {
                "id": "AdverseEvent.identifier.system",
                "path": "AdverseEvent.identifier.system",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "https://health.gov.bc.ca/fhir/NamingSystem/ca-bc-panorama-immunization-AEFI-id"
                    }
                ]
            },
            {
                "id": "AdverseEvent.identifier.value",
                "path": "AdverseEvent.identifier.value",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "IMMS.ADVERSE_EVENT.ADVERSE_EVENT_ID"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "adverseEventId"
                    }
                ]
            },
            {
                "id": "AdverseEvent.identifier.period",
                "path": "AdverseEvent.identifier.period",
                "max": "0"
            },
            {
                "id": "AdverseEvent.identifier.assigner",
                "path": "AdverseEvent.identifier.assigner",
                "max": "0"
            },
            {
                "id": "AdverseEvent.actuality",
                "path": "AdverseEvent.actuality",
                "definition": "Whether the event actually happened, or just had the potential to.",
                "comment": "Apply \"actual\" for PIR."
            },
            {
                "id": "AdverseEvent.actuality.extension",
                "path": "AdverseEvent.actuality.extension",
                "min": 1
            },
            {
                "id": "AdverseEvent.actuality.extension:_actuality",
                "path": "AdverseEvent.actuality.extension",
                "sliceName": "_actuality",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/AEFI-status-reason"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "AdverseEvent.actuality.extension:_actuality.extension",
                "path": "AdverseEvent.actuality.extension.extension",
                "min": 1
            },
            {
                "id": "AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus",
                "path": "AdverseEvent.actuality.extension.extension",
                "sliceName": "AEFIstatus",
                "short": "AEFI Status",
                "definition": "AEFI Status",
                "min": 1
            },
            {
                "id": "AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.value[x]",
                "path": "AdverseEvent.actuality.extension.extension.value[x]"
            },
            {
                "id": "AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.value[x].coding",
                "path": "AdverseEvent.actuality.extension.extension.value[x].coding"
            },
            {
                "id": "AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.value[x].coding.code",
                "path": "AdverseEvent.actuality.extension.extension.value[x].coding.code",
                "comment": "See Mappings",
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "ADVERSE_EVENT.STATUS_CODED_CNCPT_ID"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "status"
                    }
                ]
            },
            {
                "id": "AdverseEvent.actuality.extension:_actuality.extension:AEFIstatus.value[x].coding.display",
                "path": "AdverseEvent.actuality.extension.extension.value[x].coding.display",
                "comment": "See MAppings",
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "ADVERSE_EVENT.STATUS_CODED_CNCPT_ID"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "statusDescription"
                    }
                ]
            },
            {
                "id": "AdverseEvent.actuality.extension:_actuality.extension:AEFIdeleteReason",
                "path": "AdverseEvent.actuality.extension.extension",
                "sliceName": "AEFIdeleteReason",
                "short": "AEFI deleted reason",
                "definition": "AEFI deleted reason",
                "comment": "To be apply when AEFI has status = Disregard, Entered in Error or NO reason provided.  See Mappings",
                "mapping":  [
                    {
                        "identity": "source-PIR-nullReason",
                        "map": "Other"
                    }
                ]
            },
            {
                "id": "AdverseEvent.actuality.extension:_actuality.extension:AEFIdeleteReasonOther",
                "path": "AdverseEvent.actuality.extension.extension",
                "sliceName": "AEFIdeleteReasonOther",
                "short": "AEFI deleted reason = Other, specify",
                "definition": "AEFI deleted reason = Other, specify",
                "comment": "To be apply when AEFI status has OTHER reason or NO reason provided.  See Mappings.",
                "mapping":  [
                    {
                        "identity": "source-PIR-null",
                        "map": "unknown"
                    }
                ]
            },
            {
                "id": "AdverseEvent.category",
                "path": "AdverseEvent.category",
                "max": "1"
            },
            {
                "id": "AdverseEvent.subject.id",
                "path": "AdverseEvent.subject.id",
                "max": "0"
            },
            {
                "id": "AdverseEvent.subject.reference",
                "path": "AdverseEvent.subject.reference",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "fullURL of Panorama + \"Patient\" + PIR Client ID"
                    }
                ]
            },
            {
                "id": "AdverseEvent.subject.type",
                "path": "AdverseEvent.subject.type",
                "max": "0"
            },
            {
                "id": "AdverseEvent.subject.identifier",
                "path": "AdverseEvent.subject.identifier",
                "max": "0"
            },
            {
                "id": "AdverseEvent.subject.display",
                "path": "AdverseEvent.subject.display",
                "max": "0"
            },
            {
                "id": "AdverseEvent.recordedDate",
                "path": "AdverseEvent.recordedDate",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "IMMS.ADVERSE_EVENT.DATE_REPORTED"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "dateReported"
                    }
                ]
            },
            {
                "id": "AdverseEvent.resultingCondition",
                "path": "AdverseEvent.resultingCondition",
                "max": "1"
            },
            {
                "id": "AdverseEvent.contributor",
                "path": "AdverseEvent.contributor",
                "max": "1"
            },
            {
                "id": "AdverseEvent.suspectEntity",
                "path": "AdverseEvent.suspectEntity",
                "definition": "Describes the vaccine that is suspected to have caused the adverse event.",
                "min": 1
            },
            {
                "id": "AdverseEvent.suspectEntity.id",
                "path": "AdverseEvent.suspectEntity.id",
                "comment": "Apply PIR: IMMS.AE_VACCINATION.IMMUNIZATION_ID",
                "max": "0"
            },
            {
                "id": "AdverseEvent.suspectEntity.instance.id",
                "path": "AdverseEvent.suspectEntity.instance.id",
                "max": "0"
            },
            {
                "id": "AdverseEvent.suspectEntity.instance.reference",
                "path": "AdverseEvent.suspectEntity.instance.reference",
                "short": "Reference the resourceImmunization with the AEFI vaccine",
                "definition": "Reference the resourceImmunization with the AEFI vaccine",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "fullURL of Panorama + 'Immunization' + (PIR Imms ID)"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "adverseEventAssociatedImmsId"
                    }
                ]
            },
            {
                "id": "AdverseEvent.suspectEntity.instance.type",
                "path": "AdverseEvent.suspectEntity.instance.type",
                "max": "0"
            },
            {
                "id": "AdverseEvent.suspectEntity.instance.identifier",
                "path": "AdverseEvent.suspectEntity.instance.identifier",
                "max": "0"
            },
            {
                "id": "AdverseEvent.suspectEntity.instance.display",
                "path": "AdverseEvent.suspectEntity.instance.display",
                "max": "0"
            },
            {
                "id": "AdverseEvent.suspectEntity.causality",
                "path": "AdverseEvent.suspectEntity.causality",
                "max": "0"
            },
            {
                "id": "AdverseEvent.subjectMedicalHistory",
                "path": "AdverseEvent.subjectMedicalHistory",
                "max": "1"
            },
            {
                "id": "AdverseEvent.referenceDocument",
                "path": "AdverseEvent.referenceDocument",
                "max": "1"
            },
            {
                "id": "AdverseEvent.study",
                "path": "AdverseEvent.study",
                "max": "1"
            }
        ]
    }
}