BCY Immunization Distribution Service Implementation Guide

There are no (further) constraints on this element

Element id

Immunization.meta.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.meta.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

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.

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

versionId

0..1

Element id

Immunization.meta.versionId

Short description

Version specific identifier

Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Comments

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

lastUpdated

0..1

instant

Element id

Immunization.meta.lastUpdated

Short description

When the resource version last changed

Definition

When the resource last changed - e.g. when the version changed.

Comments

Updated: Relax the previously crossed-out elements.

Data type

instant

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

source

0..1

There are no (further) constraints on this element

Element id

Immunization.meta.source

Short description

Identifies where the resource comes from

Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance 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.

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.

Data type

canonical(StructureDefinition)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

profile

1..1

Element id

Immunization.meta.profile

Short description

Profiles this resource claims to conform to

Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Comments

Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Immunization'

Data type

canonical(StructureDefinition)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

security

0..1

CodingBinding

There are no (further) constraints on this element

Element id

Immunization.meta.security

Short description

Security Labels applied to this resource

Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

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.

Data type

All Security Labels (extensible)

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

tag

0..1

There are no (further) constraints on this element

Element id

Immunization.meta.tag

Short description

Tags applied to this resource

Definition

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

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.

Data type

Binding

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

CommonTags (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

Immunization.implicitRules

Short description

A set of rules under which this content was created

Definition

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

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Immunization.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

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

Data type

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

text

0..1

Narrative

There are no (further) constraints on this element

Element id

Immunization.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

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

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.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..1

Resource

There are no (further) constraints on this element

Element id

Immunization.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

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

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.

Data type

Resource

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

2..*

There are no (further) constraints on this element

Element id

Immunization.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

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

Comments

Data type

http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/immz-antigen

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

antigenDose

0..*

Extension(Complex)

Element id

Immunization.extension:antigenDose

Short description

Antgien(s) + Antigen Dose Number + Antigen Dose Status associated with the Agent administered

Alternate names

extensions, user content

Definition

Antgien(s) + Antigen Dose Number + Antigen Dose Status associated with the Agent administered

Comments

To apply for antigens information

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

pIRIdentifierExtension

1..1

Element id

Immunization.extension:pIRIdentifierExtension

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-identifier

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

pIRLockSeqNumberExtension

1..1

Element id

Immunization.extension:pIRLockSeqNumberExtension

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-lock-sequence-number

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

Immunization.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

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

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

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

identifier

1..*

Element id

Immunization.identifier

Short description

PIR internal Immunization Identifier + External Immunization ID from source system(s)

Definition

PIR Immunization Identifier(s) which include Panorama Internal Immunization ID, External Immunization ID from different source systems).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Event.identifier
w5: FiveWs.identifier
rim: .id
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id

0..1

There are no (further) constraints on this element

Element id

Immunization.identifier.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Immunization.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

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.

Data type

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

1..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Immunization.identifier.type

Short description

Description of identifier

Definition

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

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.

Data type

Identifier Type Codes (extensible)

Binding

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

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

0..0

There are no (further) constraints on this element

Element id

Immunization.identifier.type.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.identifier.type.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

coding

0..0

There are no (further) constraints on this element

Element id

Immunization.identifier.type.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

text

1..1

Element id

Immunization.identifier.type.text

Short description

Plain text representation of the concept

Definition

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

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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: PANORAMAIMMZID'
source-NHA: NHACEDARIMMS
source-VCH: VCHPARISIMMS
source-FHA: FHAPARISIMMS
source-PNet: PHARMANETIMMS
source-CznSub: CZNSUBIMMSID
source-immsBC: HEALTHCONNECT
source-eForms: EFORMIMMSID

system

1..1

Element id

Immunization.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

rim: n/a
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-id
source-NHA: https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-nha
source-FHA: https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-fha
source-VCH: https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-vcha
source-PNet: https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-pharmanet-document-number
source-CznSub: https://ehealthbc.ca/NamingSystem/ca-bc-citizen-submission
source-eForms: https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-eForm
source-immsBC: https://ehealthbc.ca/NamingSystem/ca-bc-health-connect

value

1..1

Element id

Immunization.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

See Mappings

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Examples
General

Mappings

rim: n/a
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: PIR Immunization ID
source-FHA: FHA PARIS Immunization ID
source-NHA: NHA CeDaR Immunization ID
source-VCH: VCH PARIS Immunization ID
source-PNet: PharmaNet Immunization ID
source-PHSL: immunizationId

period

Σ C

0..1

Period

There are no (further) constraints on this element

Element id

Immunization.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..1

There are no (further) constraints on this element

Element id

Immunization.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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

status

Σ ?!

1..1

codeBinding

Element id

Immunization.status

Short description

completed | entered-in-error |

Definition

Indicates the current status of the immunization record.

Comments

IDS sends "completed" or "entered-in-error" immunization records only.

Data type

ImmunizationStatusCodes (required)

Binding

A set of codes indicating the current status of an Immunization.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Event.status
w5: FiveWs.status
rim: statusCode

statusReason

0..1

There are no (further) constraints on this element

Element id

Immunization.statusReason

Short description

Reason not done

Definition

Indicates the reason the immunization event was not performed.

Comments

This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here.

Data type

ImmunizationStatusReasonCodes (example)

Binding

The reason why a vaccine was not administered.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.statusReason
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde

vaccineCode

1..1

Element id

Immunization.vaccineCode

Short description

Vaccine product administered

Definition

Vaccine that was administered.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Data type

VaccineAdministeredValueSet (example)

Binding

The code for vaccine product administered.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.code
w5: FiveWs.what[x]
v2: RXA-5
rim: .code
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code

0..0

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

pIRTradenameExtension

0..1

Element id

Immunization.vaccineCode.extension:pIRTradenameExtension

Short description

PIR Tradename

Alternate names

extensions, user content

Definition

Extension for PIR Tradename

Comments

Data type

https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-tradename

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

coding

1..*

Element id

Immunization.vaccineCode.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

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

Comments

Data type

Slicing

Unordered, Open, by $this(Value), system(Value)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

(All Slices)

The requirements in this element apply to all slices

0..0

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

system

0..1

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

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

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding.version

Short description

Version of the system - if relevant

Definition

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

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding.code

Short description

Symbol in syntax defined by the system

Definition

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

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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 ]

AgentNVC

0..*

CodingBinding

Element id

Immunization.vaccineCode.coding:AgentNVC

Short description

Agent administered

Definition

Agent code and name in NVC

Requirements

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

Comments

Data type

Binding

Generic (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:AgentNVC.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:AgentNVC.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

system

1..1

uriPattern

Element id

Immunization.vaccineCode.coding:AgentNVC.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

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

Comments

See Mappings

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Pattern

http://snomed.info/sct

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
code-NVC: https://nvc-cnv.canada.ca
code-SNOMED: http://snomed.info/sct

version

0..0

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:AgentNVC.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

1..1

Element id

Immunization.vaccineCode.coding:AgentNVC.code

Short description

Symbol in syntax defined by the system

Definition

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

Requirements

Need to refer to a particular code in the system.

Comments

See Mappings

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
source-PIR: BCYREPORTING.RBCY_FN_GET_CONCEPT_CODE(H33_VACCINATION_MASTER_ASIIS_VACC_CODE)
source-PHSL: immunizationAgentCode

display

1..1

Element id

Immunization.vaccineCode.coding:AgentNVC.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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: REPORTING.GET_ITERM_DESC(H33_VACCINATION_MASTER_ASIIS_VACC_CODE)
source-PHSL: immunizationAgentDescription

userSelected

0..0

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:AgentNVC.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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 ]

AgentPIR

1..1

Element id

Immunization.vaccineCode.coding:AgentPIR

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

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

Comments

Data type

Binding

PanoramaCodes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:AgentPIR.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:AgentPIR.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

system

1..1

uriPattern

Element id

Immunization.vaccineCode.coding:AgentPIR.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

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

Comments

See Mappings

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Pattern

https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
code-PIR: https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code

version

0..0

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:AgentPIR.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

1..1

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:AgentPIR.code

Short description

Symbol in syntax defined by the system

Definition

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

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

1..1

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:AgentPIR.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..0

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:AgentPIR.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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 ]

Tradename

0..*

CodingBinding

Element id

Immunization.vaccineCode.coding:Tradename

Short description

Tradename administered

Definition

Tradename of agent administered

Requirements

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

Comments

Tradename of agent administered

Data type

Binding

Tradename (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:Tradename.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:Tradename.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

system

1..1

uriPattern

Element id

Immunization.vaccineCode.coding:Tradename.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

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

Comments

See Mappings

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Pattern

http://snomed.info/sct

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
code-CVC: https://cvc.canimmunize.ca
code-SNOMED: http://snomed.info/sct

version

0..0

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:Tradename.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

1..1

Element id

Immunization.vaccineCode.coding:Tradename.code

Short description

Symbol in syntax defined by the system

Definition

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

Requirements

Need to refer to a particular code in the system.

Comments

See Mappings

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
source-PIR: BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE (H33_VACCINATION_MASTER.ASIIS_VACC_CODE)
source-PHSL: tradeName

display

0..1

Element id

Immunization.vaccineCode.coding:Tradename.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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: REPORTNG.GET_ITERM_DESC(H33_VACCINATION_MASTER.ASIIS_VACC_CODE)

userSelected

0..0

There are no (further) constraints on this element

Element id

Immunization.vaccineCode.coding:Tradename.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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 ]

text

0..1

Element id

Immunization.vaccineCode.text

Short description

Plain text representation of the concept

Definition

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

Requirements

Comments

See Mappings

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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: immunizationAgentCombineDescription
source-PHSL: immunizationAgentCombineDescription

patient

Σ C

1..1

Reference(Patient)

There are no (further) constraints on this element

Element id

Immunization.patient

Short description

Who was immunized

Definition

The patient who either received or did not receive the immunization.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Patient)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.subject
w5: FiveWs.subject[x]
v2: PID-3
rim: .partipication[ttypeCode=].role
w5: FiveWs.subject

0..0

There are no (further) constraints on this element

Element id

Immunization.patient.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.patient.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

reference

Σ C

1..1

Element id

Immunization.patient.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

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

Comments

See Mappings

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, ref-1

Constraints

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

Mappings

rim: n/a
rim: N/A
source-PIR: fullURL of Panorama + "Patient'+PIR Client ID

type

0..0

uriBinding

There are no (further) constraints on this element

Element id

Immunization.patient.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

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

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.

Data type

Binding

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

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

identifier

0..0

There are no (further) constraints on this element

Element id

Immunization.patient.identifier

Short description

Logical reference, when literal reference is not known

Definition

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

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

display

0..0

There are no (further) constraints on this element

Element id

Immunization.patient.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

encounter

0..1

Reference(Encounter)

There are no (further) constraints on this element

Element id

Immunization.encounter

Short description

Encounter immunization was part of

Definition

The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

Comments

Data type

Reference(Encounter)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.context
w5: FiveWs.context
v2: PV1-19
rim: component->EncounterEvent

occurrence[x]

1..1

Element id

Immunization.occurrence[x]

Short description

Vaccine administration date

Definition

Date vaccine administered

Comments

See Mappings

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Event.occurrence[x]
w5: FiveWs.done[x]
v2: RXA-3
rim: .effectiveTime
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
source-PIR: imms.h33_vaccination_master.vacc_date
source-PHSL: vaccDate

0..1

There are no (further) constraints on this element

Element id

Immunization.occurrence[x].id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.occurrence[x].extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

https://ehealthontario.ca/API/FHIR/StructureDefinition/ca-on-extension-estimated-date

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

_occurrenceDateTime

0..*

Extension(boolean)

Element id

Immunization.occurrence[x].extension:_occurrenceDateTime

Short description

Estimated Flag for Vaccination Date

Alternate names

extensions, user content

Definition

Estimated Flag for Vaccination Date

Comments

See Mappings

Data type

Extension(boolean)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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
source-PHSL: VM.VACC_DATE_ESTIMATED_IND = 'Y
source-PHSL: note="E"

0..0

There are no (further) constraints on this element

Element id

Immunization.occurrence[x].extension:_occurrenceDateTime.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.occurrence[x].extension:_occurrenceDateTime.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

url

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

Immunization.occurrence[x].extension:_occurrenceDateTime.url

Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

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.

Data type

Fixed value

https://ehealthontario.ca/API/FHIR/StructureDefinition/ca-on-extension-estimated-date

Mappings

rim: N/A

value[x]

0..1

Element id

Immunization.occurrence[x].extension:_occurrenceDateTime.value[x]

Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Comments

Apply PIR: H33_VACCINATION_MASTER.VACC_DATE

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

valueBoolean

There are no (further) constraints on this element

Data type

value

0..1

System.DateTime

There are no (further) constraints on this element

Element id

Immunization.occurrence[x].value

Short description

Primitive value for dateTime

Definition

Primitive value for dateTime

Data type

System.DateTime

recorded

0..1

There are no (further) constraints on this element

Element id

Immunization.recorded

Short description

When the immunization was first captured in the subject's record

Definition

The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
w5: FiveWs.recorded
rim: .participation[typeCode=AUT].time

primarySource

0..1

There are no (further) constraints on this element

Element id

Immunization.primarySource

Short description

Indicates context the data was recorded in

Definition

An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.

Comments

Reflects the “reliability” of the content.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
w5: FiveWs.source
v2: RXA-9
rim: immunization.uncertaintycode (if primary source=false, uncertainty=U)

reportOrigin

0..1

There are no (further) constraints on this element

Element id

Immunization.reportOrigin

Short description

Indicates the source of a secondarily reported record

Definition

The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.

Comments

Should not be populated if primarySource = True, not required even if primarySource = False.

Data type

ImmunizationOriginCodes (example)

Binding

The source of the data for a record which is not from a primary source.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.source
v2: RXA-9
rim: .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported) .participation[typeCode=INF].role[classCode=LIC] (this syntax for health care professional) .participation[typeCode=INF].role[classCode=PRS] (this syntax for family member)

location

0..1

Reference(Location)

Element id

Immunization.location

Short description

Immunization Service Delivery Location (SDL)

Definition

Immunization Service Delivery Location (SDL)

Comments

See Mappings

Data type

Reference(Location)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.location
w5: FiveWs.where[x]
v2: RXA-27 (or RXA-11, deprecated as of v2.7)
rim: .participation[typeCode=LOC].COCT_MT240000UV
source-PHSL: serviceDeliveryLocationName
source-PIR: H33_VACCINATION_MASTER.location_id

0..0

There are no (further) constraints on this element

Element id

Immunization.location.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.location.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

reference

Σ C

1..1

Element id

Immunization.location.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

fullURL of Panorama + 'Location' + PIR Loc ID + 'org' + PIR Imms Org ID

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, ref-1

Constraints

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

Mappings

rim: n/a
rim: N/A

type

0..0

uriBinding

There are no (further) constraints on this element

Element id

Immunization.location.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

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

Comments

Data type

Binding

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

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

identifier

0..0

There are no (further) constraints on this element

Element id

Immunization.location.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

display

0..0

There are no (further) constraints on this element

Element id

Immunization.location.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

manufacturer

0..1

There are no (further) constraints on this element

Element id

Immunization.manufacturer

Short description

Vaccine manufacturer

Definition

Name of vaccine manufacturer.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: RXA-17
rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name

lotNumber

0..1

Element id

Immunization.lotNumber

Short description

Vaccine lot number

Definition

Lot number of the vaccine product.

Comments

See Mappings

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: RXA-15
rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText
source-PIR: INV_PRODUCT_LOT_INFO.LOT_NUMBER
source-PHSL: lotNumber

expirationDate

0..1

date

There are no (further) constraints on this element

Element id

Immunization.expirationDate

Short description

Vaccine expiration date

Definition

Date vaccine batch expires.

Data type

date

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: RXA-16
rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime

site

0..1

There are no (further) constraints on this element

Element id

Immunization.site

Short description

Body site vaccine was administered

Definition

Body site where vaccine was administered.

Comments

Data type

CodesForImmunizationSiteOfAdministration (example)

Binding

The site at which the vaccine was administered.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: RXR-2
rim: observation.targetSiteCode
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code

0..0

There are no (further) constraints on this element

Element id

Immunization.site.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.site.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

coding

0..*

There are no (further) constraints on this element

Element id

Immunization.site.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

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

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

Immunization.site.coding.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.site.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

system

0..1

Element id

Immunization.site.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

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

Comments

Use 'http://snomed.info/sct''

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..0

There are no (further) constraints on this element

Element id

Immunization.site.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

Element id

Immunization.site.coding.code

Short description

Symbol in syntax defined by the system

Definition

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

Requirements

Need to refer to a particular code in the system.

Comments

Apply SNOMED code

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

Immunization.site.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..0

There are no (further) constraints on this element

Element id

Immunization.site.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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 ]

text

0..0

There are no (further) constraints on this element

Element id

Immunization.site.text

Short description

Plain text representation of the concept

Definition

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

Requirements

Comments

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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

route

0..1

There are no (further) constraints on this element

Element id

Immunization.route

Short description

How vaccine entered body

Definition

The path by which the vaccine product is taken into the body.

Comments

Data type

ImmunizationRouteCodes (example)

Binding

The route by which the vaccine was administered.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: RXR-1
rim: .routeCode
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code

0..0

There are no (further) constraints on this element

Element id

Immunization.route.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.route.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

coding

0..*

There are no (further) constraints on this element

Element id

Immunization.route.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

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

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..0

There are no (further) constraints on this element

Element id

Immunization.route.coding.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.route.coding.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

system

0..1

Element id

Immunization.route.coding.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

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

Comments

Use 'http://snomed.info/sct'

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..0

There are no (further) constraints on this element

Element id

Immunization.route.coding.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

Element id

Immunization.route.coding.code

Short description

Symbol in syntax defined by the system

Definition

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

Requirements

Need to refer to a particular code in the system.

Comments

Apply SNOMED code

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

There are no (further) constraints on this element

Element id

Immunization.route.coding.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..0

There are no (further) constraints on this element

Element id

Immunization.route.coding.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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 ]

text

0..0

There are no (further) constraints on this element

Element id

Immunization.route.text

Short description

Plain text representation of the concept

Definition

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

Requirements

Comments

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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

doseQuantity

0..1

SimpleQuantity

There are no (further) constraints on this element

Element id

Immunization.doseQuantity

Short description

Amount of vaccine administered

Definition

The quantity of vaccine product that was administered.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

SimpleQuantity

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: RXA-6 / RXA-7
rim: .doseQuantity

0..0

There are no (further) constraints on this element

Element id

Immunization.doseQuantity.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.doseQuantity.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

value

0..1

decimal

Element id

Immunization.doseQuantity.value

Short description

Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

See Mappings

Data type

decimal

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value
source-PIR: H33_VACCINATION_MASTER.CC_VOLUME
source-PHSL: dosage

comparator

Σ ?!

0..0

codeBinding

There are no (further) constraints on this element

Element id

Immunization.doseQuantity.comparator

Short description

< | <= | >= | > - how to understand the value

Definition

Not allowed to be used in this context

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If there is no comparator, then there is no modification of the value

Data type

Binding

How the Quantity should be understood and represented.

QuantityComparator (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: SN.1 / CQ.1
rim: IVL properties

unit

0..1

Element id

Immunization.doseQuantity.unit

Short description

Unit representation

Definition

A human-readable form of the unit.

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

See Mappings

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit
source-PIR: H33_VACCINATION_MASTER.DOSAGE_UOM_CNCPT_ID
source-PHSL: dosageUOMDescription

system

Σ C

0..0

There are no (further) constraints on this element

Element id

Immunization.doseQuantity.system

Short description

System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, qty-3

Constraints

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

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

code

0..0

There are no (further) constraints on this element

Element id

Immunization.doseQuantity.code

Short description

Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

performer

0..*

There are no (further) constraints on this element

Element id

Immunization.performer

Short description

Who performed event

Definition

Indicates who performed the immunization event.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Event.performer
v2: ORC-12 / RXA-10
rim: .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]

0..1

There are no (further) constraints on this element

Element id

Immunization.performer.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.performer.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Immunization.performer.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

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

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

function

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Immunization.performer.function

Short description

What type of performance was done

Definition

Describes the type of performance (e.g. ordering provider, administering provider, etc.).

Comments

Data type

ImmunizationFunctionCodes (extensible)

Binding

The role a practitioner or organization plays in the immunization event.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.performer.function
rim: .participation.functionCode

actor

Σ C

1..1

Reference(Organization | Practitioner | PractitionerRole)

Element id

Immunization.performer.actor

Short description

Provider who administered the vaccine

Definition

Provider who administered the vaccine

Comments

When the individual practitioner who performed the action is known, it is best to send.

Data type

Reference(Organization | Practitioner | PractitionerRole)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.performer.actor
w5: FiveWs.actor
rim: .player

0..1

There are no (further) constraints on this element

Element id

Immunization.performer.actor.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.performer.actor.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

reference

Σ C

0..1

Element id

Immunization.performer.actor.reference

Short description

Literal reference, Relative, internal or absolute URL

Definition

Comments

fullURL of Panorama + 'Practitioner' + PIR Provider ID

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, ref-1

Constraints

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

Mappings

rim: n/a
rim: N/A

type

0..1

uriBinding

There are no (further) constraints on this element

Element id

Immunization.performer.actor.type

Short description

Type the reference refers to (e.g. "Patient")

Definition

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

Comments

Data type

Binding

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

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

identifier

0..1

There are no (further) constraints on this element

Element id

Immunization.performer.actor.identifier

Short description

Logical reference, when literal reference is not known

Definition

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

display

0..1

There are no (further) constraints on this element

Element id

Immunization.performer.actor.display

Short description

Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

note

0..*

Annotation

Element id

Immunization.note

Short description

Additional immunization notes

Definition

Extra information about the immunization that is not conveyed by the other attributes.

Comments

See Mappings

Data type

Annotation

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Act
workflow: Event.note
v2: OBX-5 : OBX-3 = 48767-8
rim: note
source-PIR: IMMUNIZATION_COMMENT.COMMENT_TEXT
source-PHSL: commentText

0..1

There are no (further) constraints on this element

Element id

Immunization.note.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

2..*

There are no (further) constraints on this element

Element id

Immunization.note.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

pIRIdentifierExtension

1..1

Element id

Immunization.note.extension:pIRIdentifierExtension

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-identifier

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

pIRLockSeqNumberExtension

1..1

Element id

Immunization.note.extension:pIRLockSeqNumberExtension

Short description

Optional Extensions Element

Alternate names

extensions, user content

Definition

Optional Extension Element - found in all resources.

Comments

Data type

https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-lock-sequence-number

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

author[x]

0..1

There are no (further) constraints on this element

Element id

Immunization.note.author[x]

Short description

Individual responsible for the annotation

Definition

The individual responsible for making the annotation.

Comments

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

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Act.participant[typeCode=AUT].role

authorReference

Reference(Organization | Patient | Practitioner | RelatedPerson)

There are no (further) constraints on this element

Data type

Reference(Organization | Patient | Practitioner | RelatedPerson)

authorString

There are no (further) constraints on this element

Data type

time

0..1

There are no (further) constraints on this element

Element id

Immunization.note.time

Short description

When the annotation was made

Definition

Indicates when this particular annotation was made.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Act.effectiveTime

text

1..1

markdown

There are no (further) constraints on this element

Element id

Immunization.note.text

Short description

The annotation - text content (as markdown)

Definition

The text of the annotation in markdown format.

Comments

Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/

Data type

markdown

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Act.text

reasonCode

0..1

There are no (further) constraints on this element

Element id

Immunization.reasonCode

Short description

Why immunization occurred

Definition

Reasons why the vaccine was administered.

Comments

Data type

ImmunizationReasonCodes (example)

Binding

The reason why a vaccine was administered.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.reasonCode
rim: [actionNegationInd=false].reasonCode

reasonReference

0..1

Reference(Condition | DiagnosticReport | Observation)

There are no (further) constraints on this element

Element id

Immunization.reasonReference

Short description

Why immunization occurred

Definition

Condition, Observation or DiagnosticReport that supports why the immunization was administered.

Comments

Data type

Reference(Condition | DiagnosticReport | Observation)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.reasonReference
rim: N/A

isSubpotent

Σ ?!

0..1

Element id

Immunization.isSubpotent

Short description

Dose potency

Definition

Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent. If dose potency has been overriden, set to "true".

Comments

See Mappings

Meaning when missing

By default, a dose should be considered to be potent.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: RXA-20 = PA (partial administration)
rim: N/A
source-PIR: PIR imms.vaccine_status.status
source-PHSL: note="O"

subpotentReason

0..*

Element id

Immunization.subpotentReason

Short description

Reason + Status for being subpotent

Definition

Reason why a dose is considered to be subpotent and Status.

Comments

See Mappings

Data type

ImmunizationSubpotentReason (example)

Binding

The reason why a dose is considered to be subpotent.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: N/A
source-PIR: imms.vaccine_status.status_reason

0..1

There are no (further) constraints on this element

Element id

Immunization.subpotentReason.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.subpotentReason.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

coding

1..*

There are no (further) constraints on this element

Element id

Immunization.subpotentReason.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

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

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

text

0..1

Element id

Immunization.subpotentReason.text

Short description

Plain text representation of the concept

Definition

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

Requirements

Comments

To be applied when vaccine status = "FI" Forecaster Invalid. PIR Forecaster invalidated the imms record for the following possible reasons:

Non-WHO approved tradename
Administered prior to eligibility – interval or age
Additional dose resulting from use of multi-antigen agent
Client administered with same agent on same day

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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

education

0..1

There are no (further) constraints on this element

Element id

Immunization.education

Short description

Educational material presented to patient

Definition

Educational material presented to the patient (or guardian) at the time of vaccine administration.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
imm-1: One of documentType or reference SHALL be present
documentType.exists() or reference.exists()

Mappings

rim: n/a
rim: N/A

0..1

There are no (further) constraints on this element

Element id

Immunization.education.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.education.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Immunization.education.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

documentType

0..1

There are no (further) constraints on this element

Element id

Immunization.education.documentType

Short description

Educational material document identifier

Definition

Identifier of the material presented to the patient.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: OBX-5 : OBX-3 = 69764-9
rim: N/A

reference

0..1

There are no (further) constraints on this element

Element id

Immunization.education.reference

Short description

Educational material reference pointer

Definition

Reference pointer to the educational material given to the patient if the information was on line.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

publicationDate

0..1

There are no (further) constraints on this element

Element id

Immunization.education.publicationDate

Short description

Educational material publication date

Definition

Date the educational material was published.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: OBX-5 : OBX-3 = 29768-9
rim: N/A

presentationDate

0..1

There are no (further) constraints on this element

Element id

Immunization.education.presentationDate

Short description

Educational material presentation date

Definition

Date the educational material was given to the patient.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: OBX-5 : OBX-3 = 29769-7
rim: N/A

programEligibility

0..1

There are no (further) constraints on this element

Element id

Immunization.programEligibility

Short description

Patient eligibility for a vaccination program

Definition

Indicates a patient's eligibility for a funding program.

Comments

Data type

ImmunizationProgramEligibility (example)

Binding

The patient's eligibility for a vaccation program.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: OBX-5 : OBX-3 = 64994-7
rim: N/A

fundingSource

0..1

There are no (further) constraints on this element

Element id

Immunization.fundingSource

Short description

Funding source for the vaccine

Definition

Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).

Comments

Data type

ImmunizationFundingSource (example)

Binding

The source of funding used to purchase the vaccine administered.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: N/A

reaction

0..1

There are no (further) constraints on this element

Element id

Immunization.reaction

Short description

Details of a reaction that follows immunization

Definition

Categorical data indicating that an adverse event is associated in time to an immunization.

Comments

A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: OBX-3
rim: Observation[classCode=obs].code

0..1

There are no (further) constraints on this element

Element id

Immunization.reaction.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.reaction.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Immunization.reaction.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

date

0..1

There are no (further) constraints on this element

Element id

Immunization.reaction.date

Short description

When reaction started

Definition

Date of reaction to the immunization.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the HL7 v2 VXU message - most likely would appear in OBX segments if at all)
rim: .effectiveTime

detail

0..1

Reference(Observation)

There are no (further) constraints on this element

Element id

Immunization.reaction.detail

Short description

Additional information on reaction

Definition

Details of the reaction.

Comments

Data type

Reference(Observation)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: OBX-5
rim: .value

reported

0..1

There are no (further) constraints on this element

Element id

Immunization.reaction.reported

Short description

Indicates self-reported reaction

Definition

Self-reported indicator.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: (HL7 v2 doesn't seem to provide for this)
rim: .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)

protocolApplied

0..*

Element id

Immunization.protocolApplied

Short description

Dose Number or Revised Dose Number

Definition

Dose Number or Revised Dose Number

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

0..0

There are no (further) constraints on this element

Element id

Immunization.protocolApplied.id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.protocolApplied.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

Immunization.protocolApplied.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

series

0..0

There are no (further) constraints on this element

Element id

Immunization.protocolApplied.series

Short description

Name of vaccine series

Definition

One possible path to achieve presumed immunity against a disease - within the context of an authority.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

authority

0..0

There are no (further) constraints on this element

Element id

Immunization.protocolApplied.authority

Short description

Who is responsible for publishing the recommendations

Definition

Indicates the authority who published the protocol (e.g. ACIP) that is being followed.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: N/A

targetDisease

0..0

There are no (further) constraints on this element

Element id

Immunization.protocolApplied.targetDisease

Short description

Vaccine preventatable disease being targetted

Definition

The vaccine preventable disease the dose is being administered against.

Comments

Data type

ImmunizationTargetDiseaseCodes (example)

Binding

The vaccine preventable disease the dose is being administered for.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: N/A

doseNumber[x]

1..1

Element id

Immunization.protocolApplied.doseNumber[x]

Short description

Dose number within series

Definition

Nominal position in a series based on Antigen.

Comments

Dose Number based on Antigen Level. See Mappings

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A
source-PIR: BCYREPORTNG.RBCY_FN_GET_AGENT_DOSE_NUM(VM.IMMUNIZATION_ID)
source-PHSL: agentDoseNumber

0..1

There are no (further) constraints on this element

Element id

Immunization.protocolApplied.doseNumber[x].id

Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

Immunization.protocolApplied.doseNumber[x].extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/immz-revise-dose

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

_doseNumber

0..1

Extension(Complex)

Element id

Immunization.protocolApplied.doseNumber[x].extension:_doseNumber

Short description

Revised Dose Number + Reason + comments

Alternate names

extensions, user content

Definition

Revised Dose Number + Reason + comments

Comments

To apply when there is revised dose number in PIR.

Data type

Extension(Complex)

Extension URL

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

value

0..1

System.String

There are no (further) constraints on this element

Element id

Immunization.protocolApplied.doseNumber[x].value

Short description

Primitive value for string

Definition

Primitive value for string

Data type

System.String

Maximum string length

1048576

seriesDoses[x]

0..0

There are no (further) constraints on this element

Element id

Immunization.protocolApplied.seriesDoses[x]

Short description

Recommended number of doses for immunity

Definition

The recommended number of doses to achieve immunity.

Comments

The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Immunization

Short FHIR resource applies for PIR Immunization History

Definition

FHIR resource applies for PIR Immunization History

Cardinality 0..*

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.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-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-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: Entity. Role, or Act
workflow: Event
v2: VXU_V04
rim: SubstanceAdministration

Immunization.id

Short PIR Internal Immunization ID

Definition

PIR Internal Immunization ID

Cardinality 1..1

Summary True

Comments

See Mappings

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
source-PIR: PIR Imms ID
source-PHSL: immunizationId

Immunization.meta

Short Metadata about the resource

Definition

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

Cardinality 1..1

Meta

Summary True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Immunization.meta.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Immunization.meta.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.meta.versionId

Short Version specific identifier

Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Cardinality 0..1

Summary True

Comments

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Immunization.meta.lastUpdated

Short When the resource version last changed

Definition

When the resource last changed - e.g. when the version changed.

Cardinality 0..1

instant

Summary True

Comments

Updated: Relax the previously crossed-out elements.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Immunization.meta.source

Short Identifies where the resource comes from

Definition

Cardinality 0..1

Summary True

Comments

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Immunization.meta.profile

Short Profiles this resource claims to conform to

Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Cardinality 1..1

Type canonical(StructureDefinition)

Summary True

Comments

Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Immunization'

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Immunization.meta.security

Short Security Labels applied to this resource

Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Cardinality 0..1

All Security Labels (extensible)

Security Labels from the Healthcare Privacy and Security Classification System.

Summary True

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

Immunization.meta.tag

Short Tags applied to this resource

Definition

Cardinality 0..1

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

CommonTags (example)

Summary True

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

Immunization.implicitRules

Short A set of rules under which this content was created

Definition

Cardinality 0..1

Modifier True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Immunization.language

Short Language of the resource content

Definition

The base language in which the resource is written.

Cardinality 0..1

A human language.

CommonLanguages (preferred)

Binding extensions

maxValueSet	AllLanguages

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Immunization.text

Short Text summary of the resource, for human interpretation

Definition

Cardinality 0..1

Narrative

Alias narrative, html, xhtml, display

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A
rim: Act.text?

Immunization.contained

Short Contained, inline Resources

Definition

Cardinality 0..1

Resource

Alias inline resources, anonymous resources, contained resources

Comments

Mappings

rim: Entity. Role, or Act
rim: N/A

Immunization.extension

Short Additional content defined by implementations

Definition

Cardinality 2..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.extension:antigenDose

Short Antgien(s) + Antigen Dose Number + Antigen Dose Status associated with the Agent administered

Definition

Antgien(s) + Antigen Dose Number + Antigen Dose Status associated with the Agent administered

Cardinality 0..*

Type Extension(Complex)

Alias extensions, user content

Comments

To apply for antigens information

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.extension:pIRIdentifierExtension

Short Optional Extensions Element

Definition

Optional Extension Element - found in all resources.

Cardinality 1..1

Type Extension(string)

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.extension:pIRLockSeqNumberExtension

Short Optional Extensions Element

Definition

Optional Extension Element - found in all resources.

Cardinality 1..1

Type Extension(integer)

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.modifierExtension

Short Extensions that cannot be ignored

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Alias extensions, user content

Requirements

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.identifier

Short PIR internal Immunization Identifier + External Immunization ID from source system(s)

Definition

PIR Immunization Identifier(s) which include Panorama Internal Immunization ID, External Immunization ID from different source systems).

Cardinality 1..*

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Event.identifier
w5: FiveWs.identifier
rim: .id
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id

Immunization.identifier.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Immunization.identifier.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.identifier.use

Short usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Cardinality 0..1

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Modifier True

Summary True

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

Immunization.identifier.type

Short Description of identifier

Definition

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

Cardinality 1..1

Identifier Type Codes (extensible)

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

Summary True

Requirements

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

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

Immunization.identifier.type.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..0

Mappings

rim: n/a

Immunization.identifier.type.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.identifier.type.coding

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..0

Summary True

Requirements

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

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Immunization.identifier.type.text

Short Plain text representation of the concept

Definition

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

Cardinality 1..1

Summary True

Requirements

Comments

See Mappings

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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: PANORAMAIMMZID'
source-NHA: NHACEDARIMMS
source-VCH: VCHPARISIMMS
source-FHA: FHAPARISIMMS
source-PNet: PHARMANETIMMS
source-CznSub: CZNSUBIMMSID
source-immsBC: HEALTHCONNECT
source-eForms: EFORMIMMSID

Immunization.identifier.system

Short The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Cardinality 1..1

Summary True

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

rim: n/a
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-id
source-NHA: https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-nha
source-FHA: https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-fha
source-VCH: https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-vcha
source-PNet: https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-pharmanet-document-number
source-CznSub: https://ehealthbc.ca/NamingSystem/ca-bc-citizen-submission
source-eForms: https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-eForm
source-immsBC: https://ehealthbc.ca/NamingSystem/ca-bc-health-connect

Immunization.identifier.value

Short The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Cardinality 1..1

Summary True

Comments

See Mappings

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Examples

General

Mappings

rim: n/a
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: PIR Immunization ID
source-FHA: FHA PARIS Immunization ID
source-NHA: NHA CeDaR Immunization ID
source-VCH: VCH PARIS Immunization ID
source-PNet: PharmaNet Immunization ID
source-PHSL: immunizationId

Immunization.identifier.period

Short Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Cardinality 0..1

Period

Summary True

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

Immunization.identifier.assigner

Short Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Cardinality 0..1

Type Reference(Organization)

Summary True

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
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

Immunization.status

Short completed | entered-in-error |

Definition

Indicates the current status of the immunization record.

Cardinality 1..1

ImmunizationStatusCodes (required)

A set of codes indicating the current status of an Immunization.

Modifier True

Summary True

Comments

IDS sends "completed" or "entered-in-error" immunization records only.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Event.status
w5: FiveWs.status
rim: statusCode

Immunization.statusReason

Short Reason not done

Definition

Indicates the reason the immunization event was not performed.

Cardinality 0..1

ImmunizationStatusReasonCodes (example)

The reason why a vaccine was not administered.

Comments

This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.statusReason
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde

Immunization.vaccineCode

Short Vaccine product administered

Definition

Vaccine that was administered.

Cardinality 1..1

VaccineAdministeredValueSet (example)

The code for vaccine product administered.

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.code
w5: FiveWs.what[x]
v2: RXA-5
rim: .code
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code

Immunization.vaccineCode.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..0

Mappings

rim: n/a

Immunization.vaccineCode.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.vaccineCode.extension:pIRTradenameExtension

Short PIR Tradename

Definition

Extension for PIR Tradename

Cardinality 0..1

Type Extension(string)

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.vaccineCode.coding

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 1..*

Summary True

Requirements

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

Comments

Unordered, Open, by $this(Value), system(Value)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Immunization.vaccineCode.coding.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..0

Mappings

rim: n/a

Immunization.vaccineCode.coding.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.vaccineCode.coding.system

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 0..1

Summary True

Requirements

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

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Immunization.vaccineCode.coding.version

Short Version of the system - if relevant

Definition

Cardinality 0..1

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

Immunization.vaccineCode.coding.code

Short Symbol in syntax defined by the system

Definition

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

Cardinality 0..1

Summary True

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Immunization.vaccineCode.coding.display

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 0..1

Summary True

Requirements

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

Immunization.vaccineCode.coding.userSelected

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality 0..1

Summary True

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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 ]

Immunization.vaccineCode.coding:AgentNVC

Short Agent administered

Definition

Agent code and name in NVC

Cardinality 0..*

Summary True

Requirements

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

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Immunization.vaccineCode.coding:AgentNVC.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..0

Mappings

rim: n/a

Immunization.vaccineCode.coding:AgentNVC.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.vaccineCode.coding:AgentNVC.system

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 1..1

Summary True

Requirements

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

Comments

See Mappings

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Pattern

http://snomed.info/sct

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
code-NVC: https://nvc-cnv.canada.ca
code-SNOMED: http://snomed.info/sct

Immunization.vaccineCode.coding:AgentNVC.version

Short Version of the system - if relevant

Definition

Cardinality 0..0

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

Immunization.vaccineCode.coding:AgentNVC.code

Short Symbol in syntax defined by the system

Definition

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

Cardinality 1..1

Summary True

Requirements

Need to refer to a particular code in the system.

Comments

See Mappings

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
source-PIR: BCYREPORTING.RBCY_FN_GET_CONCEPT_CODE(H33_VACCINATION_MASTER_ASIIS_VACC_CODE)
source-PHSL: immunizationAgentCode

Immunization.vaccineCode.coding:AgentNVC.display

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 1..1

Summary True

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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: REPORTING.GET_ITERM_DESC(H33_VACCINATION_MASTER_ASIIS_VACC_CODE)
source-PHSL: immunizationAgentDescription

Immunization.vaccineCode.coding:AgentNVC.userSelected

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality 0..0

Summary True

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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 ]

Immunization.vaccineCode.coding:AgentPIR

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 1..1

PanoramaCodes (example)

Summary True

Requirements

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

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Immunization.vaccineCode.coding:AgentPIR.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..0

Mappings

rim: n/a

Immunization.vaccineCode.coding:AgentPIR.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.vaccineCode.coding:AgentPIR.system

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 1..1

Summary True

Requirements

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

Comments

See Mappings

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Pattern

https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
code-PIR: https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code

Immunization.vaccineCode.coding:AgentPIR.version

Short Version of the system - if relevant

Definition

Cardinality 0..0

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

Immunization.vaccineCode.coding:AgentPIR.code

Short Symbol in syntax defined by the system

Definition

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

Cardinality 1..1

Summary True

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Immunization.vaccineCode.coding:AgentPIR.display

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 1..1

Summary True

Requirements

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

Immunization.vaccineCode.coding:AgentPIR.userSelected

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality 0..0

Summary True

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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 ]

Immunization.vaccineCode.coding:Tradename

Short Tradename administered

Definition

Tradename of agent administered

Cardinality 0..*

Summary True

Requirements

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

Comments

Tradename of agent administered

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Immunization.vaccineCode.coding:Tradename.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..0

Mappings

rim: n/a

Immunization.vaccineCode.coding:Tradename.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.vaccineCode.coding:Tradename.system

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 1..1

Summary True

Requirements

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

Comments

See Mappings

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Pattern

http://snomed.info/sct

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
code-CVC: https://cvc.canimmunize.ca
code-SNOMED: http://snomed.info/sct

Immunization.vaccineCode.coding:Tradename.version

Short Version of the system - if relevant

Definition

Cardinality 0..0

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

Immunization.vaccineCode.coding:Tradename.code

Short Symbol in syntax defined by the system

Definition

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

Cardinality 1..1

Summary True

Requirements

Need to refer to a particular code in the system.

Comments

See Mappings

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
source-PIR: BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE (H33_VACCINATION_MASTER.ASIIS_VACC_CODE)
source-PHSL: tradeName

Immunization.vaccineCode.coding:Tradename.display

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 0..1

Summary True

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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: REPORTNG.GET_ITERM_DESC(H33_VACCINATION_MASTER.ASIIS_VACC_CODE)

Immunization.vaccineCode.coding:Tradename.userSelected

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality 0..0

Summary True

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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 ]

Immunization.vaccineCode.text

Short Plain text representation of the concept

Definition

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

Cardinality 0..1

Summary True

Requirements

Comments

See Mappings

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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: immunizationAgentCombineDescription
source-PHSL: immunizationAgentCombineDescription

Immunization.patient

Short Who was immunized

Definition

The patient who either received or did not receive the immunization.

Cardinality 1..1

Type Reference(Patient)

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.subject
w5: FiveWs.subject[x]
v2: PID-3
rim: .partipication[ttypeCode=].role
w5: FiveWs.subject

Immunization.patient.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..0

Mappings

rim: n/a

Immunization.patient.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.patient.reference

Short Literal reference, Relative, internal or absolute URL

Definition

Cardinality 1..1

Summary True

Comments

See Mappings

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, ref-1

Constraints

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

Mappings

rim: n/a
rim: N/A
source-PIR: fullURL of Panorama + "Patient'+PIR Client ID

Immunization.patient.type

Short Type the reference refers to (e.g. "Patient")

Definition

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

Cardinality 0..0

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

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Immunization.patient.identifier

Short Logical reference, when literal reference is not known

Definition

Cardinality 0..0

Summary True

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

Immunization.patient.display

Short Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Cardinality 0..0

Summary True

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Immunization.encounter

Short Encounter immunization was part of

Definition

The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

Cardinality 0..1

Type Reference(Encounter)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.context
w5: FiveWs.context
v2: PV1-19
rim: component->EncounterEvent

Immunization.occurrence[x]

Short Vaccine administration date

Definition

Date vaccine administered

Cardinality 1..1

Summary True

Comments

See Mappings

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Event.occurrence[x]
w5: FiveWs.done[x]
v2: RXA-3
rim: .effectiveTime
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
source-PIR: imms.h33_vaccination_master.vacc_date
source-PHSL: vaccDate

Immunization.occurrence[x].id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Immunization.occurrence[x].extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.occurrence[x].extension:_occurrenceDateTime

Short Estimated Flag for Vaccination Date

Definition

Estimated Flag for Vaccination Date

Cardinality 0..*

Type Extension(boolean)

Alias extensions, user content

Comments

See Mappings

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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
source-PHSL: VM.VACC_DATE_ESTIMATED_IND = 'Y
source-PHSL: note="E"

Immunization.occurrence[x].extension:_occurrenceDateTime.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..0

Mappings

rim: n/a

Immunization.occurrence[x].extension:_occurrenceDateTime.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.occurrence[x].extension:_occurrenceDateTime.url

Short identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality 1..1

Comments

Fixed Value

https://ehealthontario.ca/API/FHIR/StructureDefinition/ca-on-extension-estimated-date

Mappings

rim: N/A

Immunization.occurrence[x].extension:_occurrenceDateTime.value[x]

Short Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality 0..1

Comments

Apply PIR: H33_VACCINATION_MASTER.VACC_DATE

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Immunization.occurrence[x].value

Short Primitive value for dateTime

Definition

Primitive value for dateTime

Cardinality 0..1

Type System.DateTime

Immunization.recorded

Short When the immunization was first captured in the subject's record

Definition

The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
w5: FiveWs.recorded
rim: .participation[typeCode=AUT].time

Immunization.primarySource

Short Indicates context the data was recorded in

Definition

An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.

Cardinality 0..1

Summary True

Comments

Reflects the “reliability” of the content.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
w5: FiveWs.source
v2: RXA-9
rim: immunization.uncertaintycode (if primary source=false, uncertainty=U)

Immunization.reportOrigin

Short Indicates the source of a secondarily reported record

Definition

The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.

Cardinality 0..1

ImmunizationOriginCodes (example)

The source of the data for a record which is not from a primary source.

Comments

Should not be populated if primarySource = True, not required even if primarySource = False.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.source
v2: RXA-9
rim: .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported) .participation[typeCode=INF].role[classCode=LIC] (this syntax for health care professional) .participation[typeCode=INF].role[classCode=PRS] (this syntax for family member)

Immunization.location

Short Immunization Service Delivery Location (SDL)

Definition

Immunization Service Delivery Location (SDL)

Cardinality 0..1

Type Reference(Location)

Comments

See Mappings

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.location
w5: FiveWs.where[x]
v2: RXA-27 (or RXA-11, deprecated as of v2.7)
rim: .participation[typeCode=LOC].COCT_MT240000UV
source-PHSL: serviceDeliveryLocationName
source-PIR: H33_VACCINATION_MASTER.location_id

Immunization.location.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..0

Mappings

rim: n/a

Immunization.location.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.location.reference

Short Literal reference, Relative, internal or absolute URL

Definition

Cardinality 1..1

Summary True

Comments

fullURL of Panorama + 'Location' + PIR Loc ID + 'org' + PIR Imms Org ID

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, ref-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Immunization.location.type

Short Type the reference refers to (e.g. "Patient")

Definition

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

Cardinality 0..0

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

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Immunization.location.identifier

Short Logical reference, when literal reference is not known

Definition

Cardinality 0..0

Summary True

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

Immunization.location.display

Short Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Cardinality 0..0

Summary True

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Immunization.manufacturer

Short Vaccine manufacturer

Definition

Name of vaccine manufacturer.

Cardinality 0..1

Type Reference(Organization)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: RXA-17
rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name

Immunization.lotNumber

Short Vaccine lot number

Definition

Lot number of the vaccine product.

Cardinality 0..1

Comments

See Mappings

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: RXA-15
rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText
source-PIR: INV_PRODUCT_LOT_INFO.LOT_NUMBER
source-PHSL: lotNumber

Immunization.expirationDate

Short Vaccine expiration date

Definition

Date vaccine batch expires.

Cardinality 0..1

date

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: RXA-16
rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime

Immunization.site

Short Body site vaccine was administered

Definition

Body site where vaccine was administered.

Cardinality 0..1

CodesForImmunizationSiteOfAdministration (example)

The site at which the vaccine was administered.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: RXR-2
rim: observation.targetSiteCode
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code

Immunization.site.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..0

Mappings

rim: n/a

Immunization.site.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.site.coding

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..*

Summary True

Requirements

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

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Immunization.site.coding.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..0

Mappings

rim: n/a

Immunization.site.coding.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.site.coding.system

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 0..1

Summary True

Requirements

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

Comments

Use 'http://snomed.info/sct''

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Immunization.site.coding.version

Short Version of the system - if relevant

Definition

Cardinality 0..0

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

Immunization.site.coding.code

Short Symbol in syntax defined by the system

Definition

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

Cardinality 0..1

Summary True

Requirements

Need to refer to a particular code in the system.

Comments

Apply SNOMED code

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Immunization.site.coding.display

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 0..1

Summary True

Requirements

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

Immunization.site.coding.userSelected

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality 0..0

Summary True

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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 ]

Immunization.site.text

Short Plain text representation of the concept

Definition

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

Cardinality 0..0

Summary True

Requirements

Comments

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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

Immunization.route

Short How vaccine entered body

Definition

The path by which the vaccine product is taken into the body.

Cardinality 0..1

ImmunizationRouteCodes (example)

The route by which the vaccine was administered.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: RXR-1
rim: .routeCode
cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code

Immunization.route.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..0

Mappings

rim: n/a

Immunization.route.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.route.coding

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..*

Summary True

Requirements

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

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Immunization.route.coding.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..0

Mappings

rim: n/a

Immunization.route.coding.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.route.coding.system

Short Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Cardinality 0..1

Summary True

Requirements

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

Comments

Use 'http://snomed.info/sct'

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Immunization.route.coding.version

Short Version of the system - if relevant

Definition

Cardinality 0..0

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

Immunization.route.coding.code

Short Symbol in syntax defined by the system

Definition

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

Cardinality 0..1

Summary True

Requirements

Need to refer to a particular code in the system.

Comments

Apply SNOMED code

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Immunization.route.coding.display

Short Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Cardinality 0..1

Summary True

Requirements

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

Immunization.route.coding.userSelected

Short If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Cardinality 0..0

Summary True

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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 ]

Immunization.route.text

Short Plain text representation of the concept

Definition

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

Cardinality 0..0

Summary True

Requirements

Comments

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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

Immunization.doseQuantity

Short Amount of vaccine administered

Definition

The quantity of vaccine product that was administered.

Cardinality 0..1

SimpleQuantity

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: RXA-6 / RXA-7
rim: .doseQuantity

Immunization.doseQuantity.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..0

Mappings

rim: n/a

Immunization.doseQuantity.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.doseQuantity.value

Short Numerical value (with implicit precision)

Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Cardinality 0..1

decimal

Summary True

Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

See Mappings

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: SN.2 / CQ - N/A
rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value
source-PIR: H33_VACCINATION_MASTER.CC_VOLUME
source-PHSL: dosage

Immunization.doseQuantity.comparator

Short < | <= | >= | > - how to understand the value

Definition

Not allowed to be used in this context

Cardinality 0..0

How the Quantity should be understood and represented.

QuantityComparator (required)

Modifier True

Summary True

Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If there is no comparator, then there is no modification of the value

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: SN.1 / CQ.1
rim: IVL properties

Immunization.doseQuantity.unit

Short Unit representation

Definition

A human-readable form of the unit.

Cardinality 0..1

Summary True

Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

See Mappings

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.unit
source-PIR: H33_VACCINATION_MASTER.DOSAGE_UOM_CNCPT_ID
source-PHSL: dosageUOMDescription

Immunization.doseQuantity.system

Short System that defines coded unit form

Definition

The identification of the system that provides the coded form of the unit.

Cardinality 0..0

Summary True

Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, qty-3

Constraints

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

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: CO.codeSystem, PQ.translation.codeSystem

Immunization.doseQuantity.code

Short Coded form of the unit

Definition

A computer processable form of the unit in some unit representation system.

Cardinality 0..0

Summary True

Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: (see OBX.6 etc.) / CQ.2
rim: PQ.code, MO.currency, PQ.translation.code

Immunization.performer

Short Who performed event

Definition

Indicates who performed the immunization event.

Cardinality 0..*

Summary True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
workflow: Event.performer
v2: ORC-12 / RXA-10
rim: .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]

Immunization.performer.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Immunization.performer.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.performer.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.performer.function

Short What type of performance was done

Definition

Describes the type of performance (e.g. ordering provider, administering provider, etc.).

Cardinality 0..1

ImmunizationFunctionCodes (extensible)

The role a practitioner or organization plays in the immunization event.

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.performer.function
rim: .participation.functionCode

Immunization.performer.actor

Short Provider who administered the vaccine

Definition

Provider who administered the vaccine

Cardinality 1..1

Type Reference(Organization | Practitioner | PractitionerRole)

Summary True

Comments

When the individual practitioner who performed the action is known, it is best to send.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.performer.actor
w5: FiveWs.actor
rim: .player

Immunization.performer.actor.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Immunization.performer.actor.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.performer.actor.reference

Short Literal reference, Relative, internal or absolute URL

Definition

Cardinality 0..1

Summary True

Comments

fullURL of Panorama + 'Practitioner' + PIR Provider ID

Conditions The cardinality or value of this element may be affected by these constraints: ele-1, ref-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Immunization.performer.actor.type

Short Type the reference refers to (e.g. "Patient")

Definition

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

Cardinality 0..1

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

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Immunization.performer.actor.identifier

Short Logical reference, when literal reference is not known

Definition

Cardinality 0..1

Summary True

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
rim: .identifier

Immunization.performer.actor.display

Short Text alternative for the resource

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Cardinality 0..1

Summary True

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Immunization.note

Short Additional immunization notes

Definition

Extra information about the immunization that is not conveyed by the other attributes.

Cardinality 0..*

Annotation

Summary True

Comments

See Mappings

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Act
workflow: Event.note
v2: OBX-5 : OBX-3 = 48767-8
rim: note
source-PIR: IMMUNIZATION_COMMENT.COMMENT_TEXT
source-PHSL: commentText

Immunization.note.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Immunization.note.extension

Short Additional content defined by implementations

Definition

Cardinality 2..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.note.extension:pIRIdentifierExtension

Short Optional Extensions Element

Definition

Optional Extension Element - found in all resources.

Cardinality 1..1

Type Extension(string)

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.note.extension:pIRLockSeqNumberExtension

Short Optional Extensions Element

Definition

Optional Extension Element - found in all resources.

Cardinality 1..1

Type Extension(integer)

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.note.author[x]

Short Individual responsible for the annotation

Definition

The individual responsible for making the annotation.

Cardinality 0..1

Type Reference(Organization | Patient | Practitioner | RelatedPerson) | string

Summary True

Comments

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Act.participant[typeCode=AUT].role

Immunization.note.time

Short When the annotation was made

Definition

Indicates when this particular annotation was made.

Cardinality 0..1

Summary True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Act.effectiveTime

Immunization.note.text

Short The annotation - text content (as markdown)

Definition

The text of the annotation in markdown format.

Cardinality 1..1

markdown

Summary True

Comments

Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Act.text

Immunization.reasonCode

Short Why immunization occurred

Definition

Reasons why the vaccine was administered.

Cardinality 0..1

ImmunizationReasonCodes (example)

The reason why a vaccine was administered.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Event.reasonCode
rim: [actionNegationInd=false].reasonCode

Immunization.reasonReference

Short Why immunization occurred

Definition

Condition, Observation or DiagnosticReport that supports why the immunization was administered.

Cardinality 0..1

Type Reference(Condition | DiagnosticReport | Observation)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event.reasonReference
rim: N/A

Immunization.isSubpotent

Short Dose potency

Definition

Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent. If dose potency has been overriden, set to "true".

Cardinality 0..1

Modifier True

Summary True

Comments

See Mappings

Meaning when missing

By default, a dose should be considered to be potent.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: RXA-20 = PA (partial administration)
rim: N/A
source-PIR: PIR imms.vaccine_status.status
source-PHSL: note="O"

Immunization.subpotentReason

Short Reason + Status for being subpotent

Definition

Reason why a dose is considered to be subpotent and Status.

Cardinality 0..*

ImmunizationSubpotentReason (example)

The reason why a dose is considered to be subpotent.

Comments

See Mappings

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: N/A
source-PIR: imms.vaccine_status.status_reason

Immunization.subpotentReason.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Immunization.subpotentReason.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.subpotentReason.coding

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 1..*

Summary True

Requirements

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

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Immunization.subpotentReason.text

Short Plain text representation of the concept

Definition

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

Cardinality 0..1

Summary True

Requirements

Comments

To be applied when vaccine status = "FI" Forecaster Invalid. PIR Forecaster invalidated the imms record for the following possible reasons:

Non-WHO approved tradename
Administered prior to eligibility – interval or age
Additional dose resulting from use of multi-antigen agent
Client administered with same agent on same day

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
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

Immunization.education

Short Educational material presented to patient

Definition

Educational material presented to the patient (or guardian) at the time of vaccine administration.

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
imm-1: One of documentType or reference SHALL be present
documentType.exists() or reference.exists()

Mappings

rim: n/a
rim: N/A

Immunization.education.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Immunization.education.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.education.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.education.documentType

Short Educational material document identifier

Definition

Identifier of the material presented to the patient.

Cardinality 0..1

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: OBX-5 : OBX-3 = 69764-9
rim: N/A

Immunization.education.reference

Short Educational material reference pointer

Definition

Reference pointer to the educational material given to the patient if the information was on line.

Cardinality 0..1

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Immunization.education.publicationDate

Short Educational material publication date

Definition

Date the educational material was published.

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: OBX-5 : OBX-3 = 29768-9
rim: N/A

Immunization.education.presentationDate

Short Educational material presentation date

Definition

Date the educational material was given to the patient.

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: OBX-5 : OBX-3 = 29769-7
rim: N/A

Immunization.programEligibility

Short Patient eligibility for a vaccination program

Definition

Indicates a patient's eligibility for a funding program.

Cardinality 0..1

ImmunizationProgramEligibility (example)

The patient's eligibility for a vaccation program.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: OBX-5 : OBX-3 = 64994-7
rim: N/A

Immunization.fundingSource

Short Funding source for the vaccine

Definition

Cardinality 0..1

ImmunizationFundingSource (example)

The source of funding used to purchase the vaccine administered.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: N/A

Immunization.reaction

Short Details of a reaction that follows immunization

Definition

Categorical data indicating that an adverse event is associated in time to an immunization.

Cardinality 0..1

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: OBX-3
rim: Observation[classCode=obs].code

Immunization.reaction.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Immunization.reaction.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.reaction.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.reaction.date

Short When reaction started

Definition

Date of reaction to the immunization.

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the HL7 v2 VXU message - most likely would appear in OBX segments if at all)
rim: .effectiveTime

Immunization.reaction.detail

Short Additional information on reaction

Definition

Details of the reaction.

Cardinality 0..1

Type Reference(Observation)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: OBX-5
rim: .value

Immunization.reaction.reported

Short Indicates self-reported reaction

Definition

Self-reported indicator.

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: (HL7 v2 doesn't seem to provide for this)
rim: .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)

Immunization.protocolApplied

Short Dose Number or Revised Dose Number

Definition

Dose Number or Revised Dose Number

Cardinality 0..*

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Immunization.protocolApplied.id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..0

Mappings

rim: n/a

Immunization.protocolApplied.extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.protocolApplied.modifierExtension

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Immunization.protocolApplied.series

Short Name of vaccine series

Definition

One possible path to achieve presumed immunity against a disease - within the context of an authority.

Cardinality 0..0

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Immunization.protocolApplied.authority

Short Who is responsible for publishing the recommendations

Definition

Indicates the authority who published the protocol (e.g. ACIP) that is being followed.

Cardinality 0..0

Type Reference(Organization)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: N/A

Immunization.protocolApplied.targetDisease

Short Vaccine preventatable disease being targetted

Definition

The vaccine preventable disease the dose is being administered against.

Cardinality 0..0

ImmunizationTargetDiseaseCodes (example)

The vaccine preventable disease the dose is being administered for.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: N/A

Immunization.protocolApplied.doseNumber[x]

Short Dose number within series

Definition

Nominal position in a series based on Antigen.

Cardinality 1..1

Comments

Dose Number based on Antigen Level. See Mappings

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A
source-PIR: BCYREPORTNG.RBCY_FN_GET_AGENT_DOSE_NUM(VM.IMMUNIZATION_ID)
source-PHSL: agentDoseNumber

Immunization.protocolApplied.doseNumber[x].id

Short Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality 0..1

Mappings

rim: n/a

Immunization.protocolApplied.doseNumber[x].extension

Short Additional content defined by implementations

Definition

Cardinality 0..*

Alias extensions, user content

Comments