Immunization
The FHIR resource Immunization is for historic Immunization records
Immunization | I | Immunization | |
id | Σ | 1..1 | string |
meta | Σ | 1..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | Σ | 0..1 | id |
lastUpdated | Σ | 0..1 | instant |
source | Σ | 0..1 | uri |
profile | Σ | 1..1 | canonical(StructureDefinition) |
security | Σ | 0..1 | CodingBinding |
tag | Σ | 0..1 | Coding |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..1 | Resource | |
extension | I | 0..* | Extension |
antigenDose | I | 0..* | Extension(Complex) |
modifierExtension | ?! I | 0..* | Extension |
identifier | 1..* | Identifier | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 1..1 | CodeableConceptBinding |
id | 0..0 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..0 | Coding |
text | Σ | 1..1 | string |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
status | Σ ?! | 1..1 | codeBinding |
statusReason | 0..1 | CodeableConcept | |
vaccineCode | Σ | 1..1 | CodeableConcept |
id | 0..0 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
(All Slices) | |||
id | 0..0 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uri |
version | Σ | 0..1 | string |
code | Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
AgentNVC | Σ | 1..1 | Coding |
id | 0..0 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uri |
version | Σ | 0..0 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..0 | boolean |
AgentPIR | Σ | 0..1 | Coding |
id | 0..0 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uri |
version | Σ | 0..0 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..0 | boolean |
Tradename | Σ | 0..1 | Coding |
id | 0..0 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uri |
version | Σ | 0..0 | string |
code | Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
text | Σ | 0..1 | string |
patient | Σ | 1..1 | Reference(Patient) |
id | 0..0 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 1..1 | string |
type | Σ | 0..0 | uriBinding |
identifier | Σ | 0..0 | Identifier |
display | Σ | 0..0 | string |
encounter | 0..1 | Reference(Encounter) | |
occurrence[x] | Σ | 1..1 | |
occurrenceDateTime | dateTime | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
_occurrenceDateTime | I | 0..* | Extension(boolean) |
id | 0..0 | string | |
extension | I | 0..* | Extension |
url | 1..1 | uriFixed Value | |
value[x] | 0..1 | ||
valueBoolean | boolean | ||
value | 0..1 | System.DateTime | |
recorded | 0..1 | dateTime | |
primarySource | Σ | 0..1 | boolean |
reportOrigin | 0..1 | CodeableConcept | |
location | 0..1 | Reference(Location) | |
id | 0..0 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 1..1 | string |
type | Σ | 0..0 | uriBinding |
identifier | Σ | 0..0 | Identifier |
display | Σ | 0..0 | string |
manufacturer | 0..1 | Reference(Organization) | |
lotNumber | 0..1 | string | |
expirationDate | 0..1 | date | |
site | 0..1 | CodeableConcept | |
id | 0..0 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..0 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uri |
version | Σ | 0..0 | string |
code | Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
text | Σ | 0..0 | string |
route | 0..1 | CodeableConcept | |
id | 0..0 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..0 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uri |
version | Σ | 0..0 | string |
code | Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..0 | boolean |
text | Σ | 0..0 | string |
doseQuantity | 0..1 | SimpleQuantity | |
id | 0..0 | string | |
extension | I | 0..* | Extension |
value | Σ | 0..1 | decimal |
comparator | Σ ?! | 0..0 | codeBinding |
unit | Σ | 0..1 | string |
system | Σ I | 0..0 | uri |
code | Σ | 0..0 | code |
performer | Σ | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
function | Σ | 0..1 | CodeableConceptBinding |
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 0..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
display | Σ | 0..1 | string |
note | Σ | 0..* | Annotation |
reasonCode | 0..1 | CodeableConcept | |
reasonReference | 0..1 | Reference(Condition | Observation | DiagnosticReport) | |
isSubpotent | Σ ?! | 0..1 | boolean |
subpotentReason | 0..* | CodeableConcept | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 1..1 | Coding |
doseStatusReason | Σ | 0..1 | Coding |
id | 0..0 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
doseStatus | Σ | 1..1 | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
education | I | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
documentType | 0..1 | string | |
reference | 0..1 | uri | |
publicationDate | 0..1 | dateTime | |
presentationDate | 0..1 | dateTime | |
programEligibility | 0..1 | CodeableConcept | |
fundingSource | 0..1 | CodeableConcept | |
reaction | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
date | 0..1 | dateTime | |
detail | 0..1 | Reference(Observation) | |
reported | 0..1 | boolean | |
protocolApplied | 0..* | BackboneElement | |
id | 0..0 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
series | 0..0 | string | |
authority | 0..0 | Reference(Organization) | |
targetDisease | 0..0 | CodeableConcept | |
doseNumber[x] | 1..1 | ||
doseNumberString | string | ||
id | 0..1 | string | |
extension | I | 0..* | Extension |
_doseNumber | I | 0..1 | Extension(Complex) |
value | 0..1 | System.String | |
seriesDoses[x] | 0..0 |
Immunization | |
Definition | FHIR resource applies for PIR Immunization History |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Immunization.id | |
Definition | PIR Internal Immunization ID |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | See Mappings |
Mappings |
|
Immunization.meta | |
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 |
Type | Meta |
Summary | True |
Invariants |
|
Immunization.meta.id | |
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 |
Type | string |
Mappings |
|
Immunization.meta.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.meta.versionId | |
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 |
Type | id |
Summary | True |
Comments | Apply "2025.01.1". This indicates the FHIR Specs as of year 2025 Jan. |
Invariants |
|
Immunization.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...1 |
Type | instant |
Summary | True |
Comments | Updated: Relax the previously crossed-out elements. |
Invariants |
|
Immunization.meta.source | |
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. |
Invariants |
|
Immunization.meta.profile | |
Definition | A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url). |
Cardinality | 1...1 |
Type | canonical(StructureDefinition) |
Summary | True |
Comments | Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Immunization' |
Invariants |
|
Immunization.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...1 |
Type | Coding |
Binding | 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. |
Invariants |
|
Immunization.meta.tag | |
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. |
Cardinality | 0...1 |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
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. |
Invariants |
|
Immunization.implicitRules | |
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. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Immunization.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Immunization.text | |
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. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Immunization.contained | |
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. |
Cardinality | 0...1 |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Immunization.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.extension:antigenDose | |
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 |
Invariants |
|
Mappings |
|
Immunization.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Immunization.identifier | |
Definition | PIR Immunization Identifier(s) which include Panorama Internal Immunization ID, External Immunization ID from different source systems). |
Cardinality | 1...* |
Type | Identifier |
Invariants |
|
Mappings |
|
Immunization.identifier.id | |
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 |
Type | string |
Mappings |
|
Immunization.identifier.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . |
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. |
Invariants |
|
Mappings |
|
Immunization.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | 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 | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Invariants |
|
Mappings |
|
Immunization.identifier.type.id | |
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 |
Type | string |
Mappings |
|
Immunization.identifier.type.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.identifier.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...0 |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Immunization.identifier.type.text | |
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 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Immunization.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 1...1 |
Type | uri |
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 |
Invariants |
|
Examples | General http://www.acme.com/identifiers/patient |
Mappings |
|
Immunization.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | See Mappings |
Invariants |
|
Examples | General 123456 |
Mappings |
|
Immunization.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
Immunization.identifier.assigner | |
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. |
Invariants |
|
Mappings |
|
Immunization.status | |
Definition | Indicates the current status of the immunization record. |
Cardinality | 1...1 |
Type | code |
Binding | 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. |
Invariants |
|
Mappings |
|
Immunization.statusReason | |
Definition | Indicates the reason the immunization event was not performed. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | 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. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode | |
Definition | Vaccine that was administered. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | The code for vaccine product administered. |
Summary | True |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.id | |
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 |
Type | string |
Mappings |
|
Immunization.vaccineCode.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
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. |
Slicing | Unordered, Open, by code(Value) |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding.id | |
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 |
Type | string |
Mappings |
|
Immunization.vaccineCode.coding.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding.version | |
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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding.code | |
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 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding.userSelected | |
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 |
Type | boolean |
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 | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:AgentNVC | |
Definition | Agent code and name in NVC |
Cardinality | 1...1 |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:AgentNVC.id | |
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 |
Type | string |
Mappings |
|
Immunization.vaccineCode.coding:AgentNVC.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:AgentNVC.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:AgentNVC.version | |
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. |
Cardinality | 0...0 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:AgentNVC.code | |
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 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:AgentNVC.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 1...1 |
Type | string |
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 |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:AgentNVC.userSelected | |
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 |
Type | boolean |
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 | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:AgentPIR | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:AgentPIR.id | |
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 |
Type | string |
Mappings |
|
Immunization.vaccineCode.coding:AgentPIR.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:AgentPIR.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:AgentPIR.version | |
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. |
Cardinality | 0...0 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:AgentPIR.code | |
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 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:AgentPIR.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:AgentPIR.userSelected | |
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 |
Type | boolean |
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 | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:Tradename | |
Definition | Tradename of agent administered |
Cardinality | 0...1 |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Tradename of agent administered |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:Tradename.id | |
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 |
Type | string |
Mappings |
|
Immunization.vaccineCode.coding:Tradename.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:Tradename.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:Tradename.version | |
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. |
Cardinality | 0...0 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:Tradename.code | |
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 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:Tradename.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
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 |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.coding:Tradename.userSelected | |
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 |
Type | boolean |
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 | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Immunization.vaccineCode.text | |
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 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Immunization.patient | |
Definition | The patient who either received or did not receive the immunization. |
Cardinality | 1...1 |
Type | Reference(Patient) |
Summary | True |
Invariants |
|
Mappings |
|
Immunization.patient.id | |
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 |
Type | string |
Mappings |
|
Immunization.patient.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.patient.reference | |
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. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Immunization.patient.type | |
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). |
Cardinality | 0...0 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
Immunization.patient.identifier | |
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. |
Cardinality | 0...0 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
Immunization.patient.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...0 |
Type | string |
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. |
Invariants |
|
Mappings |
|
Immunization.encounter | |
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) |
Invariants |
|
Mappings |
|
Immunization.occurrence[x] | |
Definition | Date vaccine administered |
Cardinality | 1...1 |
Type | dateTime |
Summary | True |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Immunization.occurrence[x].id | |
Definition | unique id for the element within a resource (for internal references) |
Cardinality | 0...1 |
Type | string |
Immunization.occurrence[x].extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Immunization.occurrence[x].extension:_occurrenceDateTime | |
Definition | Estimated Flag for Vaccination Date |
Cardinality | 0...* |
Type | Extension(boolean) |
Alias | extensions, user content |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Immunization.occurrence[x].extension:_occurrenceDateTime.id | |
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 |
Type | string |
Mappings |
|
Immunization.occurrence[x].extension:_occurrenceDateTime.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.occurrence[x].extension:_occurrenceDateTime.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Cardinality | 1...1 |
Type | uri |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | https://ehealthontario.ca/API/FHIR/StructureDefinition/ca-on-extension-estimated-date |
Mappings |
|
Immunization.occurrence[x].extension:_occurrenceDateTime.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list). |
Cardinality | 0...1 |
Type | boolean |
Comments | Apply PIR: H33_VACCINATION_MASTER.VACC_DATE |
Invariants |
|
Mappings |
|
Immunization.occurrence[x].value | |
Definition | The actual value |
Cardinality | 0...1 |
Type | System.DateTime |
Immunization.recorded | |
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 |
Type | dateTime |
Invariants |
|
Mappings |
|
Immunization.primarySource | |
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 |
Type | boolean |
Summary | True |
Comments | Reflects the “reliability” of the content. |
Invariants |
|
Mappings |
|
Immunization.reportOrigin | |
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 |
Type | CodeableConcept |
Binding | 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. |
Invariants |
|
Mappings |
|
Immunization.location | |
Definition | Immunization Service Delivery Location (SDL) |
Cardinality | 0...1 |
Type | Reference(Location) |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Immunization.location.id | |
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 |
Type | string |
Mappings |
|
Immunization.location.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.location.reference | |
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. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | fullURL of Panorama + 'Location' + PIR Loc ID + 'org' + PIR Imms Org ID |
Invariants |
|
Mappings |
|
Immunization.location.type | |
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). |
Cardinality | 0...0 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
Immunization.location.identifier | |
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. |
Cardinality | 0...0 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
Immunization.location.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...0 |
Type | string |
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. |
Invariants |
|
Mappings |
|
Immunization.manufacturer | |
Definition | Name of vaccine manufacturer. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Invariants |
|
Mappings |
|
Immunization.lotNumber | |
Definition | Lot number of the vaccine product. |
Cardinality | 0...1 |
Type | string |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Immunization.expirationDate | |
Definition | Date vaccine batch expires. |
Cardinality | 0...1 |
Type | date |
Invariants |
|
Mappings |
|
Immunization.site | |
Definition | Body site where vaccine was administered. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The site at which the vaccine was administered. |
Invariants |
|
Mappings |
|
Immunization.site.id | |
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 |
Type | string |
Mappings |
|
Immunization.site.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.site.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Immunization.site.coding.id | |
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 |
Type | string |
Mappings |
|
Immunization.site.coding.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.site.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | Use 'http://snomed.info/sct'' |
Invariants |
|
Mappings |
|
Immunization.site.coding.version | |
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. |
Cardinality | 0...0 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Immunization.site.coding.code | |
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 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Apply SNOMED code |
Invariants |
|
Mappings |
|
Immunization.site.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Immunization.site.coding.userSelected | |
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 |
Type | boolean |
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 | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Immunization.site.text | |
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 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Immunization.route | |
Definition | The path by which the vaccine product is taken into the body. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The route by which the vaccine was administered. |
Invariants |
|
Mappings |
|
Immunization.route.id | |
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 |
Type | string |
Mappings |
|
Immunization.route.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.route.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Immunization.route.coding.id | |
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 |
Type | string |
Mappings |
|
Immunization.route.coding.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.route.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | Use 'http://snomed.info/sct' |
Invariants |
|
Mappings |
|
Immunization.route.coding.version | |
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. |
Cardinality | 0...0 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Immunization.route.coding.code | |
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 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Apply SNOMED code |
Invariants |
|
Mappings |
|
Immunization.route.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Immunization.route.coding.userSelected | |
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 |
Type | boolean |
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 | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Immunization.route.text | |
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 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Immunization.doseQuantity | |
Definition | The quantity of vaccine product that was administered. |
Cardinality | 0...1 |
Type | SimpleQuantity |
Invariants |
|
Mappings |
|
Immunization.doseQuantity.id | |
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 |
Type | string |
Mappings |
|
Immunization.doseQuantity.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.doseQuantity.value | |
Definition | The value of the measured amount. The value includes an implicit precision in the presentation of the value. |
Cardinality | 0...1 |
Type | decimal |
Summary | True |
Requirements | Precision is handled implicitly in almost all cases of measurement. |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Immunization.doseQuantity.comparator | |
Definition | Not allowed to be used in this context |
Cardinality | 0...0 |
Type | code |
Binding | How the Quantity should be understood and represented. |
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. |
Invariants |
|
Mappings |
|
Immunization.doseQuantity.unit | |
Definition | A human-readable form of the unit. |
Cardinality | 0...1 |
Type | string |
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 |
Invariants |
|
Mappings |
|
Immunization.doseQuantity.system | |
Definition | The identification of the system that provides the coded form of the unit. |
Cardinality | 0...0 |
Type | uri |
Summary | True |
Requirements | Need to know the system that defines the coded form of the unit. |
Invariants |
|
Mappings |
|
Immunization.doseQuantity.code | |
Definition | A computer processable form of the unit in some unit representation system. |
Cardinality | 0...0 |
Type | code |
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. |
Invariants |
|
Mappings |
|
Immunization.performer | |
Definition | Indicates who performed the immunization event. |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Invariants |
|
Mappings |
|
Immunization.performer.id | |
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 |
Type | string |
Mappings |
|
Immunization.performer.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Immunization.performer.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Immunization.performer.function | |
Definition | Describes the type of performance (e.g. ordering provider, administering provider, etc.). |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The role a practitioner or organization plays in the immunization event. |
Summary | True |
Invariants |
|
Mappings |
|
Immunization.performer.actor | |
Definition | Provider who administered the vaccine |
Cardinality | 1...1 |
Type | Reference(Practitioner | PractitionerRole | Organization) |
Summary | True |
Comments | When the individual practitioner who performed the action is known, it is best to send. |
Invariants |
|
Mappings |
|
Immunization.performer.actor.id | |
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 |
Type | string |
Mappings |
|
Immunization.performer.actor.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.performer.actor.reference | |
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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | fullURL of Panorama + 'Practitioner' + PIR Provider ID |
Invariants |
|
Mappings |
|
Immunization.performer.actor.type | |
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). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
Immunization.performer.actor.identifier | |
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. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
Immunization.performer.actor.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
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. |
Invariants |
|
Mappings |
|
Immunization.note | |
Definition | Extra information about the immunization that is not conveyed by the other attributes. |
Cardinality | 0...* |
Type | Annotation |
Summary | True |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Immunization.reasonCode | |
Definition | Reasons why the vaccine was administered. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The reason why a vaccine was administered. |
Invariants |
|
Mappings |
|
Immunization.reasonReference | |
Definition | Condition, Observation or DiagnosticReport that supports why the immunization was administered. |
Cardinality | 0...1 |
Type | Reference(Condition | Observation | DiagnosticReport) |
Invariants |
|
Mappings |
|
Immunization.isSubpotent | |
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 |
Type | boolean |
Modifier | True |
Summary | True |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Immunization.subpotentReason | |
Definition | Reason why a dose is considered to be subpotent and Status. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The reason why a dose is considered to be subpotent. |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Immunization.subpotentReason.id | |
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 |
Type | string |
Mappings |
|
Immunization.subpotentReason.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.subpotentReason.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Summary | True |
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. |
Slicing | Unordered, Open, by code(Value) |
Invariants |
|
Mappings |
|
Immunization.subpotentReason.coding:doseStatusReason | |
Definition | Dose Status Overriden Reason |
Cardinality | 0...1 |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | To be applied when vaccine status = "OI", "OV". |
Invariants |
|
Mappings |
|
Immunization.subpotentReason.coding:doseStatusReason.id | |
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 |
Type | string |
Mappings |
|
Immunization.subpotentReason.coding:doseStatusReason.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.subpotentReason.coding:doseStatusReason.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Immunization.subpotentReason.coding:doseStatusReason.version | |
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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Immunization.subpotentReason.coding:doseStatusReason.code | |
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 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Immunization.subpotentReason.coding:doseStatusReason.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 1...1 |
Type | string |
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 |
Invariants |
|
Mappings |
|
Immunization.subpotentReason.coding:doseStatusReason.userSelected | |
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 |
Type | boolean |
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 | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Immunization.subpotentReason.coding:doseStatus | |
Definition | Dose Status if overriden (from Valid to Invalid) or (from Invalid to Valid) |
Cardinality | 1...1 |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Immunization.subpotentReason.coding:doseStatus.id | |
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 |
Type | string |
Mappings |
|
Immunization.subpotentReason.coding:doseStatus.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Immunization.subpotentReason.coding:doseStatus.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | Use 'https://ehealth.bc.ca/fhir/CodeSystem/ca-bc-dose-status' |
Invariants |
|
Mappings |
|
Immunization.subpotentReason.coding:doseStatus.version | |
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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Immunization.subpotentReason.coding:doseStatus.code | |
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 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Immunization.subpotentReason.coding:doseStatus.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 1...1 |
Type | string |
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 |
Invariants |
|
Mappings |
|
Immunization.subpotentReason.coding:doseStatus.userSelected | |
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 |
Type | boolean |
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 | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Immunization.subpotentReason.text | |
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 |
Type | string |
Summary | True |
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 | To be applied when vaccine status = "FI" Forecaster Invalid. PIR Forecaster invalidated the imms record for the following possible reasons:
|
Invariants |
|
Mappings |
|
Immunization.education | |
Definition | Educational material presented to the patient (or guardian) at the time of vaccine administration. |
Cardinality | 0...1 |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Immunization.education.id | |
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 |
Type | string |
Mappings |
|
Immunization.education.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Immunization.education.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Immunization.education.documentType | |
Definition | Identifier of the material presented to the patient. |
Cardinality | 0...1 |
Type | string |
Invariants |
|
Mappings |
|
Immunization.education.reference | |
Definition | Reference pointer to the educational material given to the patient if the information was on line. |
Cardinality | 0...1 |
Type | uri |
Invariants |
|
Mappings |
|
Immunization.education.publicationDate | |
Definition | Date the educational material was published. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Immunization.education.presentationDate | |
Definition | Date the educational material was given to the patient. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Immunization.programEligibility | |
Definition | Indicates a patient's eligibility for a funding program. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The patient's eligibility for a vaccation program. |
Invariants |
|
Mappings |
|
Immunization.fundingSource | |
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). |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The source of funding used to purchase the vaccine administered. |
Invariants |
|
Mappings |
|
Immunization.reaction | |
Definition | Categorical data indicating that an adverse event is associated in time to an immunization. |
Cardinality | 0...1 |
Type | BackboneElement |
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. |
Invariants |
|
Mappings |
|
Immunization.reaction.id | |
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 |
Type | string |
Mappings |
|
Immunization.reaction.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Immunization.reaction.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Immunization.reaction.date | |
Definition | Date of reaction to the immunization. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Immunization.reaction.detail | |
Definition | Details of the reaction. |
Cardinality | 0...1 |
Type | Reference(Observation) |
Invariants |
|
Mappings |
|
Immunization.reaction.reported | |
Definition | Self-reported indicator. |
Cardinality | 0...1 |
Type | boolean |
Invariants |
|
Mappings |
|
Immunization.protocolApplied | |
Definition | Dose Number or Revised Dose Number |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Immunization.protocolApplied.id | |
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 |
Type | string |
Mappings |
|
Immunization.protocolApplied.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Immunization.protocolApplied.modifierExtension | |
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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Immunization.protocolApplied.series | |
Definition | One possible path to achieve presumed immunity against a disease - within the context of an authority. |
Cardinality | 0...0 |
Type | string |
Invariants |
|
Mappings |
|
Immunization.protocolApplied.authority | |
Definition | Indicates the authority who published the protocol (e.g. ACIP) that is being followed. |
Cardinality | 0...0 |
Type | Reference(Organization) |
Invariants |
|
Mappings |
|
Immunization.protocolApplied.targetDisease | |
Definition | The vaccine preventable disease the dose is being administered against. |
Cardinality | 0...0 |
Type | CodeableConcept |
Binding | The vaccine preventable disease the dose is being administered for. |
Invariants |
|
Mappings |
|
Immunization.protocolApplied.doseNumber[x] | |
Definition | Nominal position in a series based on Antigen. |
Cardinality | 1...1 |
Type | string |
Comments | Dose Number based on Antigen Level. See Mappings |
Invariants |
|
Mappings |
|
Immunization.protocolApplied.doseNumber[x].id | |
Definition | unique id for the element within a resource (for internal references) |
Cardinality | 0...1 |
Type | string |
Immunization.protocolApplied.doseNumber[x].extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Immunization.protocolApplied.doseNumber[x].extension:_doseNumber | |
Definition | Revised Dose Number + Reason + comments |
Cardinality | 0...1 |
Type | Extension(Complex) |
Alias | extensions, user content |
Comments | To apply when there is revised dose number in PIR. |
Invariants |
|
Mappings |
|
Immunization.protocolApplied.doseNumber[x].value | |
Definition | The actual value |
Cardinality | 0...1 |
Type | System.String |
Immunization.protocolApplied.seriesDoses[x] | |
Definition | The recommended number of doses to achieve immunity. |
Cardinality | 0...0 |
Type | positiveInt |
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). |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="02bfa3ad-4130-4ac6-a64e-a4f34fffb6a3" /> <meta> <versionId value="26" /> <lastUpdated value="2025-01-24T22:53:20.4967554+00:00" /> </meta> <url value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Immunization" /> <name value="Immunization" /> <status value="draft" /> <date value="2022-02-04T19:50:20.0867005+00:00" /> <fhirVersion value="4.0.1" /> <mapping> <identity value="workflow" /> <uri value="http://hl7.org/fhir/workflow" /> <name value="Workflow Pattern" /> </mapping> <mapping> <identity value="v2" /> <uri value="http://hl7.org/v2" /> <name value="HL7 v2 Mapping" /> </mapping> <mapping> <identity value="rim" /> <uri value="http://hl7.org/v3" /> <name value="RIM Mapping" /> </mapping> <mapping> <identity value="w5" /> <uri value="http://hl7.org/fhir/fivews" /> <name value="FiveWs Pattern Mapping" /> </mapping> <mapping> <identity value="cda" /> <uri value="http://hl7.org/v3/cda" /> <name value="CDA (R2)" /> </mapping> <kind value="resource" /> <abstract value="false" /> <type value="Immunization" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Immunization" /> <derivation value="constraint" /> <differential> <element id="Immunization"> <path value="Immunization" /> <short value="FHIR resource applies for PIR Immunization History" /> <definition value="FHIR resource applies for PIR Immunization History" /> </element> <element id="Immunization.id"> <path value="Immunization.id" /> <short value="PIR Internal Immunization ID" /> <definition value="PIR Internal Immunization ID" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="source-PIR" /> <map value="PIR Imms ID" /> </mapping> <mapping> <identity value="source-PHSL" /> <map value="immunizationId" /> </mapping> </element> <element id="Immunization.meta"> <path value="Immunization.meta" /> <min value="1" /> </element> <element id="Immunization.meta.versionId"> <path value="Immunization.meta.versionId" /> <comment value="Apply "2025.01.1". This indicates the FHIR Specs as of year 2025 Jan." /> </element> <element id="Immunization.meta.lastUpdated"> <path value="Immunization.meta.lastUpdated" /> <comment value="Updated: Relax the previously crossed-out elements." /> </element> <element id="Immunization.meta.profile"> <path value="Immunization.meta.profile" /> <comment value="Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Immunization'" /> <min value="1" /> <max value="1" /> </element> <element id="Immunization.meta.security"> <path value="Immunization.meta.security" /> <max value="1" /> </element> <element id="Immunization.meta.tag"> <path value="Immunization.meta.tag" /> <max value="1" /> </element> <element id="Immunization.contained"> <path value="Immunization.contained" /> <max value="1" /> </element> <element id="Immunization.extension:antigenDose"> <path value="Immunization.extension" /> <sliceName value="antigenDose" /> <short value="Antgien(s) + Antigen Dose Number + Antigen Dose Status associated with the Agent administered" /> <definition value="Antgien(s) + Antigen Dose Number + Antigen Dose Status associated with the Agent administered" /> <type> <code value="Extension" /> <profile value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/immz-antigen" /> </type> </element> <element id="Immunization.identifier"> <path value="Immunization.identifier" /> <short value="PIR internal Immunization Identifier + External Immunization ID from source system(s)" /> <definition value="PIR Immunization Identifier(s) which include Panorama Internal Immunization ID, External Immunization ID from different source systems)." /> <min value="1" /> </element> <element id="Immunization.identifier.type"> <path value="Immunization.identifier.type" /> <min value="1" /> </element> <element id="Immunization.identifier.type.id"> <path value="Immunization.identifier.type.id" /> <max value="0" /> </element> <element id="Immunization.identifier.type.coding"> <path value="Immunization.identifier.type.coding" /> <max value="0" /> </element> <element id="Immunization.identifier.type.text"> <path value="Immunization.identifier.type.text" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="source-PIR" /> <map value="PANORAMAIMMZID'" /> </mapping> <mapping> <identity value="source-NHA" /> <map value="NHACEDARIMMS" /> </mapping> <mapping> <identity value="source-VCH" /> <map value="VCHPARISIMMS" /> </mapping> <mapping> <identity value="source-FHA" /> <map value="FHAPARISIMMS" /> </mapping> <mapping> <identity value="source-PNet" /> <map value="PHARMANETIMMS" /> </mapping> <mapping> <identity value="source-CznSub" /> <map value="CZNSUBIMMSID" /> </mapping> <mapping> <identity value="source-immsBC" /> <map value="HEALTHCONNECT" /> </mapping> <mapping> <identity value="source-eForms" /> <map value="EFORMIMMSID" /> </mapping> </element> <element id="Immunization.identifier.system"> <path value="Immunization.identifier.system" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="source-PIR" /> <map value="https://health.gov.bc.ca/fhir/NamingSystem/ca-bc-panorama-immunization-id" /> </mapping> <mapping> <identity value="source-NHA" /> <map value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-nha" /> </mapping> <mapping> <identity value="source-FHA" /> <map value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-fha" /> </mapping> <mapping> <identity value="source-VCH" /> <map value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-vcha" /> </mapping> <mapping> <identity value="source-PNet" /> <map value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-pharmanet-document-number" /> </mapping> <mapping> <identity value="source-CznSub" /> <map value="https://ehealthbc.ca/NamingSystem/ca-bc-citizen-submission" /> </mapping> <mapping> <identity value="source-eForms" /> <map value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-eForm" /> </mapping> <mapping> <identity value="source-immsBC" /> <map value="https://ehealthbc.ca/NamingSystem/ca-bc-health-connect" /> </mapping> </element> <element id="Immunization.identifier.value"> <path value="Immunization.identifier.value" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="source-PIR" /> <map value="PIR Immunization ID" /> </mapping> <mapping> <identity value="source-FHA" /> <map value="FHA PARIS Immunization ID" /> </mapping> <mapping> <identity value="source-NHA" /> <map value="NHA CeDaR Immunization ID" /> </mapping> <mapping> <identity value="source-VCH" /> <map value="VCH PARIS Immunization ID" /> </mapping> <mapping> <identity value="source-PNet" /> <map value="PharmaNet Immunization ID" /> </mapping> <mapping> <identity value="source-PHSL" /> <map value="immunizationId" /> </mapping> </element> <element id="Immunization.status"> <path value="Immunization.status" /> <short value="completed | entered-in-error |" /> <definition value="Indicates the current status of the immunization record." /> <comment value="IDS sends "completed" or "entered-in-error" immunization records only." /> </element> <element id="Immunization.vaccineCode"> <path value="Immunization.vaccineCode" /> <definition value="Vaccine that was administered." /> </element> <element id="Immunization.vaccineCode.id"> <path value="Immunization.vaccineCode.id" /> <max value="0" /> </element> <element id="Immunization.vaccineCode.coding"> <path value="Immunization.vaccineCode.coding" /> <slicing> <discriminator> <type value="value" /> <path value="code" /> </discriminator> <rules value="open" /> </slicing> </element> <element id="Immunization.vaccineCode.coding.id"> <path value="Immunization.vaccineCode.coding.id" /> <max value="0" /> </element> <element id="Immunization.vaccineCode.coding:AgentNVC"> <path value="Immunization.vaccineCode.coding" /> <sliceName value="AgentNVC" /> <short value="Agent administered" /> <definition value="Agent code and name in NVC" /> <min value="1" /> <max value="1" /> </element> <element id="Immunization.vaccineCode.coding:AgentNVC.id"> <path value="Immunization.vaccineCode.coding.id" /> <max value="0" /> </element> <element id="Immunization.vaccineCode.coding:AgentNVC.system"> <path value="Immunization.vaccineCode.coding.system" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="code-NVC" /> <map value="https://nvc-cnv.canada.ca" /> </mapping> <mapping> <identity value="code-SNOMED" /> <map value="http://snomed.info/sct" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:AgentNVC.version"> <path value="Immunization.vaccineCode.coding.version" /> <max value="0" /> </element> <element id="Immunization.vaccineCode.coding:AgentNVC.code"> <path value="Immunization.vaccineCode.coding.code" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="source-PIR" /> <map value="BCYREPORTING.RBCY_FN_GET_CONCEPT_CODE(H33_VACCINATION_MASTER_ASIIS_VACC_CODE)" /> </mapping> <mapping> <identity value="source-PHSL" /> <map value="immunizationAgentCode" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:AgentNVC.display"> <path value="Immunization.vaccineCode.coding.display" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="source-PIR" /> <map value="REPORTING.GET_ITERM_DESC(H33_VACCINATION_MASTER_ASIIS_VACC_CODE)" /> </mapping> <mapping> <identity value="source-PHSL" /> <map value="immunizationAgentDescription" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:AgentNVC.userSelected"> <path value="Immunization.vaccineCode.coding.userSelected" /> <max value="0" /> </element> <element id="Immunization.vaccineCode.coding:AgentPIR"> <path value="Immunization.vaccineCode.coding" /> <sliceName value="AgentPIR" /> <max value="1" /> </element> <element id="Immunization.vaccineCode.coding:AgentPIR.id"> <path value="Immunization.vaccineCode.coding.id" /> <max value="0" /> </element> <element id="Immunization.vaccineCode.coding:AgentPIR.system"> <path value="Immunization.vaccineCode.coding.system" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="code-PIR" /> <map value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:AgentPIR.version"> <path value="Immunization.vaccineCode.coding.version" /> <max value="0" /> </element> <element id="Immunization.vaccineCode.coding:AgentPIR.code"> <path value="Immunization.vaccineCode.coding.code" /> <min value="1" /> </element> <element id="Immunization.vaccineCode.coding:AgentPIR.display"> <path value="Immunization.vaccineCode.coding.display" /> <min value="1" /> </element> <element id="Immunization.vaccineCode.coding:AgentPIR.userSelected"> <path value="Immunization.vaccineCode.coding.userSelected" /> <max value="0" /> </element> <element id="Immunization.vaccineCode.coding:Tradename"> <path value="Immunization.vaccineCode.coding" /> <sliceName value="Tradename" /> <short value="Tradename administered" /> <definition value="Tradename of agent administered" /> <comment value="Tradename of agent administered" /> <max value="1" /> </element> <element id="Immunization.vaccineCode.coding:Tradename.id"> <path value="Immunization.vaccineCode.coding.id" /> <max value="0" /> </element> <element id="Immunization.vaccineCode.coding:Tradename.system"> <path value="Immunization.vaccineCode.coding.system" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="code-CVC" /> <map value="https://cvc.canimmunize.ca" /> </mapping> <mapping> <identity value="code-SNOMED" /> <map value="http://snomed.info/sct" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:Tradename.version"> <path value="Immunization.vaccineCode.coding.version" /> <max value="0" /> </element> <element id="Immunization.vaccineCode.coding:Tradename.code"> <path value="Immunization.vaccineCode.coding.code" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="source-PIR" /> <map value="BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE (H33_VACCINATION_MASTER.ASIIS_VACC_CODE)" /> </mapping> <mapping> <identity value="source-PHSL" /> <map value="tradeName" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:Tradename.display"> <path value="Immunization.vaccineCode.coding.display" /> <comment value="See Mappings" /> <mapping> <identity value="source-PIR" /> <map value="REPORTNG.GET_ITERM_DESC(H33_VACCINATION_MASTER.ASIIS_VACC_CODE)" /> </mapping> </element> <element id="Immunization.vaccineCode.coding:Tradename.userSelected"> <path value="Immunization.vaccineCode.coding.userSelected" /> <max value="0" /> </element> <element id="Immunization.vaccineCode.text"> <path value="Immunization.vaccineCode.text" /> <comment value="See Mappings" /> <mapping> <identity value="source-PIR" /> <map value="immunizationAgentCombineDescription" /> </mapping> <mapping> <identity value="source-PHSL" /> <map value="immunizationAgentCombineDescription" /> </mapping> </element> <element id="Immunization.patient.id"> <path value="Immunization.patient.id" /> <max value="0" /> </element> <element id="Immunization.patient.reference"> <path value="Immunization.patient.reference" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="source-PIR" /> <map value="fullURL of Panorama + "Patient'+PIR Client ID" /> </mapping> </element> <element id="Immunization.patient.type"> <path value="Immunization.patient.type" /> <max value="0" /> </element> <element id="Immunization.patient.identifier"> <path value="Immunization.patient.identifier" /> <max value="0" /> </element> <element id="Immunization.patient.display"> <path value="Immunization.patient.display" /> <max value="0" /> </element> <element id="Immunization.occurrence[x]"> <path value="Immunization.occurrence[x]" /> <definition value="Date vaccine administered" /> <comment value="See Mappings" /> <type> <code value="dateTime" /> </type> <mapping> <identity value="source-PIR" /> <map value="imms.h33_vaccination_master.vacc_date" /> </mapping> <mapping> <identity value="source-PHSL" /> <map value="vaccDate" /> </mapping> </element> <element id="Immunization.occurrence[x].extension:_occurrenceDateTime"> <path value="Immunization.occurrence[x].extension" /> <sliceName value="_occurrenceDateTime" /> <short value="Estimated Flag for Vaccination Date" /> <definition value="Estimated Flag for Vaccination Date" /> <comment value="See Mappings" /> <type> <code value="Extension" /> <profile value="https://ehealthontario.ca/API/FHIR/StructureDefinition/ca-on-extension-estimated-date" /> </type> <mapping> <identity value="source-PHSL" /> <map value="VM.VACC_DATE_ESTIMATED_IND = 'Y" /> </mapping> <mapping> <identity value="source-PHSL" /> <map value="note="E"" /> </mapping> </element> <element id="Immunization.occurrence[x].extension:_occurrenceDateTime.value[x]"> <path value="Immunization.occurrence[x].extension.value[x]" /> <comment value="Apply PIR: H33_VACCINATION_MASTER.VACC_DATE" /> </element> <element id="Immunization.location"> <path value="Immunization.location" /> <short value="Immunization Service Delivery Location (SDL)" /> <definition value="Immunization Service Delivery Location (SDL)" /> <comment value="See Mappings" /> <mapping> <identity value="source-PHSL" /> <map value="serviceDeliveryLocationName" /> </mapping> <mapping> <identity value="source-PIR" /> <map value="H33_VACCINATION_MASTER.location_id" /> </mapping> </element> <element id="Immunization.location.id"> <path value="Immunization.location.id" /> <max value="0" /> </element> <element id="Immunization.location.reference"> <path value="Immunization.location.reference" /> <comment value="fullURL of Panorama + 'Location' + PIR Loc ID + 'org' + PIR Imms Org ID" /> <min value="1" /> </element> <element id="Immunization.location.type"> <path value="Immunization.location.type" /> <max value="0" /> </element> <element id="Immunization.location.identifier"> <path value="Immunization.location.identifier" /> <max value="0" /> </element> <element id="Immunization.location.display"> <path value="Immunization.location.display" /> <max value="0" /> </element> <element id="Immunization.lotNumber"> <path value="Immunization.lotNumber" /> <comment value="See Mappings" /> <mapping> <identity value="source-PIR" /> <map value="INV_PRODUCT_LOT_INFO.LOT_NUMBER" /> </mapping> <mapping> <identity value="source-PHSL" /> <map value="lotNumber" /> </mapping> </element> <element id="Immunization.site.id"> <path value="Immunization.site.id" /> <max value="0" /> </element> <element id="Immunization.site.coding.id"> <path value="Immunization.site.coding.id" /> <max value="0" /> </element> <element id="Immunization.site.coding.system"> <path value="Immunization.site.coding.system" /> <comment value="Use 'http://snomed.info/sct''" /> </element> <element id="Immunization.site.coding.version"> <path value="Immunization.site.coding.version" /> <max value="0" /> </element> <element id="Immunization.site.coding.code"> <path value="Immunization.site.coding.code" /> <comment value="Apply SNOMED code" /> </element> <element id="Immunization.site.coding.userSelected"> <path value="Immunization.site.coding.userSelected" /> <max value="0" /> </element> <element id="Immunization.site.text"> <path value="Immunization.site.text" /> <max value="0" /> </element> <element id="Immunization.route.id"> <path value="Immunization.route.id" /> <max value="0" /> </element> <element id="Immunization.route.coding.id"> <path value="Immunization.route.coding.id" /> <max value="0" /> </element> <element id="Immunization.route.coding.system"> <path value="Immunization.route.coding.system" /> <comment value="Use 'http://snomed.info/sct'" /> </element> <element id="Immunization.route.coding.version"> <path value="Immunization.route.coding.version" /> <max value="0" /> </element> <element id="Immunization.route.coding.code"> <path value="Immunization.route.coding.code" /> <comment value="Apply SNOMED code" /> </element> <element id="Immunization.route.coding.userSelected"> <path value="Immunization.route.coding.userSelected" /> <max value="0" /> </element> <element id="Immunization.route.text"> <path value="Immunization.route.text" /> <max value="0" /> </element> <element id="Immunization.doseQuantity.id"> <path value="Immunization.doseQuantity.id" /> <max value="0" /> </element> <element id="Immunization.doseQuantity.value"> <path value="Immunization.doseQuantity.value" /> <comment value="See Mappings" /> <mapping> <identity value="source-PIR" /> <map value="H33_VACCINATION_MASTER.CC_VOLUME" /> </mapping> <mapping> <identity value="source-PHSL" /> <map value="dosage" /> </mapping> </element> <element id="Immunization.doseQuantity.unit"> <path value="Immunization.doseQuantity.unit" /> <comment value="See Mappings" /> <mapping> <identity value="source-PIR" /> <map value="H33_VACCINATION_MASTER.DOSAGE_UOM_CNCPT_ID" /> </mapping> <mapping> <identity value="source-PHSL" /> <map value="dosageUOMDescription" /> </mapping> </element> <element id="Immunization.doseQuantity.system"> <path value="Immunization.doseQuantity.system" /> <max value="0" /> </element> <element id="Immunization.doseQuantity.code"> <path value="Immunization.doseQuantity.code" /> <max value="0" /> </element> <element id="Immunization.performer.actor"> <path value="Immunization.performer.actor" /> <short value="Provider who administered the vaccine" /> <definition value="Provider who administered the vaccine" /> </element> <element id="Immunization.performer.actor.reference"> <path value="Immunization.performer.actor.reference" /> <comment value="fullURL of Panorama + 'Practitioner' + PIR Provider ID" /> </element> <element id="Immunization.note"> <path value="Immunization.note" /> <comment value="See Mappings" /> <mapping> <identity value="source-PIR" /> <map value="IMMUNIZATION_COMMENT.COMMENT_TEXT" /> </mapping> <mapping> <identity value="source-PHSL" /> <map value="commentText" /> </mapping> </element> <element id="Immunization.reasonCode"> <path value="Immunization.reasonCode" /> <max value="1" /> </element> <element id="Immunization.reasonReference"> <path value="Immunization.reasonReference" /> <max value="1" /> </element> <element id="Immunization.isSubpotent"> <path value="Immunization.isSubpotent" /> <definition value="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"." /> <comment value="See Mappings" /> <mapping> <identity value="source-PIR" /> <map value="PIR imms.vaccine_status.status" /> <comment value="If invalid, "1350752"" /> </mapping> <mapping> <identity value="source-PHSL" /> <map value="note="O"" /> </mapping> </element> <element id="Immunization.subpotentReason"> <path value="Immunization.subpotentReason" /> <short value="Reason + Status for being subpotent" /> <definition value="Reason why a dose is considered to be subpotent and Status." /> <comment value="See Mappings" /> <mapping> <identity value="source-PIR" /> <map value="imms.vaccine_status.status_reason" /> </mapping> </element> <element id="Immunization.subpotentReason.coding"> <path value="Immunization.subpotentReason.coding" /> <slicing> <discriminator> <type value="value" /> <path value="code" /> </discriminator> <rules value="open" /> </slicing> <min value="1" /> <max value="1" /> </element> <element id="Immunization.subpotentReason.coding:doseStatusReason"> <path value="Immunization.subpotentReason.coding" /> <sliceName value="doseStatusReason" /> <short value="Slice 1: Dose Status Overriden Reason" /> <definition value="Dose Status Overriden Reason" /> <comment value="To be applied when vaccine status = "OI", "OV"." /> <max value="1" /> </element> <element id="Immunization.subpotentReason.coding:doseStatusReason.id"> <path value="Immunization.subpotentReason.coding.id" /> <max value="0" /> </element> <element id="Immunization.subpotentReason.coding:doseStatusReason.system"> <path value="Immunization.subpotentReason.coding.system" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="source-PIR" /> <map value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code" /> </mapping> </element> <element id="Immunization.subpotentReason.coding:doseStatusReason.code"> <path value="Immunization.subpotentReason.coding.code" /> <min value="1" /> </element> <element id="Immunization.subpotentReason.coding:doseStatusReason.display"> <path value="Immunization.subpotentReason.coding.display" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="source-PIR-doseStatusReason" /> <map value=""Reason - " + BCYREPORTNG.RBCY_FN_GET_AGENT_STATUS(H33_VACCINATION_MASTER.IMMUNIZATION_ID)" /> </mapping> </element> <element id="Immunization.subpotentReason.coding:doseStatus"> <path value="Immunization.subpotentReason.coding" /> <sliceName value="doseStatus" /> <short value="Dose Status if overriden" /> <definition value="Dose Status if overriden (from Valid to Invalid) or (from Invalid to Valid)" /> <min value="1" /> <max value="1" /> </element> <element id="Immunization.subpotentReason.coding:doseStatus.system"> <path value="Immunization.subpotentReason.coding.system" /> <comment value="Use 'https://ehealth.bc.ca/fhir/CodeSystem/ca-bc-dose-status'" /> <min value="1" /> </element> <element id="Immunization.subpotentReason.coding:doseStatus.code"> <path value="Immunization.subpotentReason.coding.code" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="source-PIR" /> <map value="BCYREPORTNG.RBCY_FN_GET_AGENT_STATUS" /> </mapping> <mapping> <identity value="source-PHSL" /> <map value="agentOverrideStatus" /> </mapping> </element> <element id="Immunization.subpotentReason.coding:doseStatus.display"> <path value="Immunization.subpotentReason.coding.display" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="source-PIR-status" /> <map value=""Status - " + BCYREPORTNG.RBCY_FN_GET_AGENT_STATUS (VM.IMMUNIZATION_ID) = 'Valid (override)'" /> </mapping> </element> <element id="Immunization.subpotentReason.text"> <path value="Immunization.subpotentReason.text" /> <comment value="To be applied when vaccine status = "FI" Forecaster Invalid.\nPIR Forecaster invalidated the imms record for the following possible reasons:\n1. Non-WHO approved tradename\n2. Administered prior to eligibility – interval or age \n3. Additional dose resulting from use of multi-antigen agent\n4. Client administered with same agent on same day" /> </element> <element id="Immunization.education"> <path value="Immunization.education" /> <max value="1" /> </element> <element id="Immunization.programEligibility"> <path value="Immunization.programEligibility" /> <max value="1" /> </element> <element id="Immunization.reaction"> <path value="Immunization.reaction" /> <max value="1" /> </element> <element id="Immunization.protocolApplied"> <path value="Immunization.protocolApplied" /> <short value="Dose Number or Revised Dose Number" /> <definition value="Dose Number or Revised Dose Number" /> </element> <element id="Immunization.protocolApplied.id"> <path value="Immunization.protocolApplied.id" /> <max value="0" /> </element> <element id="Immunization.protocolApplied.series"> <path value="Immunization.protocolApplied.series" /> <max value="0" /> </element> <element id="Immunization.protocolApplied.authority"> <path value="Immunization.protocolApplied.authority" /> <max value="0" /> </element> <element id="Immunization.protocolApplied.targetDisease"> <path value="Immunization.protocolApplied.targetDisease" /> <max value="0" /> </element> <element id="Immunization.protocolApplied.doseNumber[x]"> <path value="Immunization.protocolApplied.doseNumber[x]" /> <definition value="Nominal position in a series based on Antigen." /> <comment value="Dose Number based on Antigen Level. See Mappings" /> <type> <code value="string" /> </type> <mapping> <identity value="source-PIR" /> <map value="BCYREPORTNG.RBCY_FN_GET_AGENT_DOSE_NUM(VM.IMMUNIZATION_ID)" /> </mapping> <mapping> <identity value="source-PHSL" /> <map value="agentDoseNumber" /> </mapping> </element> <element id="Immunization.protocolApplied.doseNumber[x].extension:_doseNumber"> <path value="Immunization.protocolApplied.doseNumber[x].extension" /> <sliceName value="_doseNumber" /> <short value="Revised Dose Number + Reason + comments" /> <definition value="Revised Dose Number + Reason + comments" /> <max value="1" /> <type> <code value="Extension" /> <profile value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/immz-revise-dose" /> </type> <isModifier value="false" /> </element> <element id="Immunization.protocolApplied.seriesDoses[x]"> <path value="Immunization.protocolApplied.seriesDoses[x]" /> <max value="0" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "02bfa3ad-4130-4ac6-a64e-a4f34fffb6a3", "meta": { "versionId": "26", "lastUpdated": "01/24/2025 22:53:20" }, "url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Immunization", "name": "Immunization", "status": "draft", "date": "02/04/2022 19:50:20", "fhirVersion": "4.0.1", "mapping": [ { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern" }, { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping" }, { "identity": "cda", "uri": "http://hl7.org/v3/cda", "name": "CDA (R2)" } ], "kind": "resource", "abstract": false, "type": "Immunization", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization", "derivation": "constraint", "differential": { "element": [ { "id": "Immunization", "path": "Immunization", "short": "FHIR resource applies for PIR Immunization History", "definition": "FHIR resource applies for PIR Immunization History" }, { "id": "Immunization.id", "path": "Immunization.id", "short": "PIR Internal Immunization ID", "definition": "PIR Internal Immunization ID", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "PIR Imms ID" }, { "identity": "source-PHSL", "map": "immunizationId" } ] }, { "id": "Immunization.meta", "path": "Immunization.meta", "min": 1 }, { "id": "Immunization.meta.versionId", "path": "Immunization.meta.versionId", "comment": "Apply \"2025.01.1\". This indicates the FHIR Specs as of year 2025 Jan." }, { "id": "Immunization.meta.lastUpdated", "path": "Immunization.meta.lastUpdated", "comment": "Updated: Relax the previously crossed-out elements." }, { "id": "Immunization.meta.profile", "path": "Immunization.meta.profile", "comment": "Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Immunization'", "min": 1, "max": "1" }, { "id": "Immunization.meta.security", "path": "Immunization.meta.security", "max": "1" }, { "id": "Immunization.meta.tag", "path": "Immunization.meta.tag", "max": "1" }, { "id": "Immunization.contained", "path": "Immunization.contained", "max": "1" }, { "id": "Immunization.extension:antigenDose", "path": "Immunization.extension", "sliceName": "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", "type": [ { "code": "Extension", "profile": [ "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/immz-antigen" ] } ] }, { "id": "Immunization.identifier", "path": "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).", "min": 1 }, { "id": "Immunization.identifier.type", "path": "Immunization.identifier.type", "min": 1 }, { "id": "Immunization.identifier.type.id", "path": "Immunization.identifier.type.id", "max": "0" }, { "id": "Immunization.identifier.type.coding", "path": "Immunization.identifier.type.coding", "max": "0" }, { "id": "Immunization.identifier.type.text", "path": "Immunization.identifier.type.text", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "PANORAMAIMMZID'" }, { "identity": "source-NHA", "map": "NHACEDARIMMS" }, { "identity": "source-VCH", "map": "VCHPARISIMMS" }, { "identity": "source-FHA", "map": "FHAPARISIMMS" }, { "identity": "source-PNet", "map": "PHARMANETIMMS" }, { "identity": "source-CznSub", "map": "CZNSUBIMMSID" }, { "identity": "source-immsBC", "map": "HEALTHCONNECT" }, { "identity": "source-eForms", "map": "EFORMIMMSID" } ] }, { "id": "Immunization.identifier.system", "path": "Immunization.identifier.system", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "https://health.gov.bc.ca/fhir/NamingSystem/ca-bc-panorama-immunization-id" }, { "identity": "source-NHA", "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-nha" }, { "identity": "source-FHA", "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-fha" }, { "identity": "source-VCH", "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-vcha" }, { "identity": "source-PNet", "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-pharmanet-document-number" }, { "identity": "source-CznSub", "map": "https://ehealthbc.ca/NamingSystem/ca-bc-citizen-submission" }, { "identity": "source-eForms", "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-eForm" }, { "identity": "source-immsBC", "map": "https://ehealthbc.ca/NamingSystem/ca-bc-health-connect" } ] }, { "id": "Immunization.identifier.value", "path": "Immunization.identifier.value", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "PIR Immunization ID" }, { "identity": "source-FHA", "map": "FHA PARIS Immunization ID" }, { "identity": "source-NHA", "map": "NHA CeDaR Immunization ID" }, { "identity": "source-VCH", "map": "VCH PARIS Immunization ID" }, { "identity": "source-PNet", "map": "PharmaNet Immunization ID" }, { "identity": "source-PHSL", "map": "immunizationId" } ] }, { "id": "Immunization.status", "path": "Immunization.status", "short": "completed | entered-in-error |", "definition": "Indicates the current status of the immunization record.", "comment": "IDS sends \"completed\" or \"entered-in-error\" immunization records only." }, { "id": "Immunization.vaccineCode", "path": "Immunization.vaccineCode", "definition": "Vaccine that was administered." }, { "id": "Immunization.vaccineCode.id", "path": "Immunization.vaccineCode.id", "max": "0" }, { "id": "Immunization.vaccineCode.coding", "path": "Immunization.vaccineCode.coding", "slicing": { "discriminator": [ { "type": "value", "path": "code" } ], "rules": "open" } }, { "id": "Immunization.vaccineCode.coding.id", "path": "Immunization.vaccineCode.coding.id", "max": "0" }, { "id": "Immunization.vaccineCode.coding:AgentNVC", "path": "Immunization.vaccineCode.coding", "sliceName": "AgentNVC", "short": "Agent administered", "definition": "Agent code and name in NVC", "min": 1, "max": "1" }, { "id": "Immunization.vaccineCode.coding:AgentNVC.id", "path": "Immunization.vaccineCode.coding.id", "max": "0" }, { "id": "Immunization.vaccineCode.coding:AgentNVC.system", "path": "Immunization.vaccineCode.coding.system", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "code-NVC", "map": "https://nvc-cnv.canada.ca" }, { "identity": "code-SNOMED", "map": "http://snomed.info/sct" } ] }, { "id": "Immunization.vaccineCode.coding:AgentNVC.version", "path": "Immunization.vaccineCode.coding.version", "max": "0" }, { "id": "Immunization.vaccineCode.coding:AgentNVC.code", "path": "Immunization.vaccineCode.coding.code", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "BCYREPORTING.RBCY_FN_GET_CONCEPT_CODE(H33_VACCINATION_MASTER_ASIIS_VACC_CODE)" }, { "identity": "source-PHSL", "map": "immunizationAgentCode" } ] }, { "id": "Immunization.vaccineCode.coding:AgentNVC.display", "path": "Immunization.vaccineCode.coding.display", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "REPORTING.GET_ITERM_DESC(H33_VACCINATION_MASTER_ASIIS_VACC_CODE)" }, { "identity": "source-PHSL", "map": "immunizationAgentDescription" } ] }, { "id": "Immunization.vaccineCode.coding:AgentNVC.userSelected", "path": "Immunization.vaccineCode.coding.userSelected", "max": "0" }, { "id": "Immunization.vaccineCode.coding:AgentPIR", "path": "Immunization.vaccineCode.coding", "sliceName": "AgentPIR", "max": "1" }, { "id": "Immunization.vaccineCode.coding:AgentPIR.id", "path": "Immunization.vaccineCode.coding.id", "max": "0" }, { "id": "Immunization.vaccineCode.coding:AgentPIR.system", "path": "Immunization.vaccineCode.coding.system", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "code-PIR", "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code" } ] }, { "id": "Immunization.vaccineCode.coding:AgentPIR.version", "path": "Immunization.vaccineCode.coding.version", "max": "0" }, { "id": "Immunization.vaccineCode.coding:AgentPIR.code", "path": "Immunization.vaccineCode.coding.code", "min": 1 }, { "id": "Immunization.vaccineCode.coding:AgentPIR.display", "path": "Immunization.vaccineCode.coding.display", "min": 1 }, { "id": "Immunization.vaccineCode.coding:AgentPIR.userSelected", "path": "Immunization.vaccineCode.coding.userSelected", "max": "0" }, { "id": "Immunization.vaccineCode.coding:Tradename", "path": "Immunization.vaccineCode.coding", "sliceName": "Tradename", "short": "Tradename administered", "definition": "Tradename of agent administered", "comment": "Tradename of agent administered", "max": "1" }, { "id": "Immunization.vaccineCode.coding:Tradename.id", "path": "Immunization.vaccineCode.coding.id", "max": "0" }, { "id": "Immunization.vaccineCode.coding:Tradename.system", "path": "Immunization.vaccineCode.coding.system", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "code-CVC", "map": "https://cvc.canimmunize.ca" }, { "identity": "code-SNOMED", "map": "http://snomed.info/sct" } ] }, { "id": "Immunization.vaccineCode.coding:Tradename.version", "path": "Immunization.vaccineCode.coding.version", "max": "0" }, { "id": "Immunization.vaccineCode.coding:Tradename.code", "path": "Immunization.vaccineCode.coding.code", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE (H33_VACCINATION_MASTER.ASIIS_VACC_CODE)" }, { "identity": "source-PHSL", "map": "tradeName" } ] }, { "id": "Immunization.vaccineCode.coding:Tradename.display", "path": "Immunization.vaccineCode.coding.display", "comment": "See Mappings", "mapping": [ { "identity": "source-PIR", "map": "REPORTNG.GET_ITERM_DESC(H33_VACCINATION_MASTER.ASIIS_VACC_CODE)" } ] }, { "id": "Immunization.vaccineCode.coding:Tradename.userSelected", "path": "Immunization.vaccineCode.coding.userSelected", "max": "0" }, { "id": "Immunization.vaccineCode.text", "path": "Immunization.vaccineCode.text", "comment": "See Mappings", "mapping": [ { "identity": "source-PIR", "map": "immunizationAgentCombineDescription" }, { "identity": "source-PHSL", "map": "immunizationAgentCombineDescription" } ] }, { "id": "Immunization.patient.id", "path": "Immunization.patient.id", "max": "0" }, { "id": "Immunization.patient.reference", "path": "Immunization.patient.reference", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "fullURL of Panorama + \"Patient'+PIR Client ID" } ] }, { "id": "Immunization.patient.type", "path": "Immunization.patient.type", "max": "0" }, { "id": "Immunization.patient.identifier", "path": "Immunization.patient.identifier", "max": "0" }, { "id": "Immunization.patient.display", "path": "Immunization.patient.display", "max": "0" }, { "id": "Immunization.occurrence[x]", "path": "Immunization.occurrence[x]", "definition": "Date vaccine administered", "comment": "See Mappings", "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "source-PIR", "map": "imms.h33_vaccination_master.vacc_date" }, { "identity": "source-PHSL", "map": "vaccDate" } ] }, { "id": "Immunization.occurrence[x].extension:_occurrenceDateTime", "path": "Immunization.occurrence[x].extension", "sliceName": "_occurrenceDateTime", "short": "Estimated Flag for Vaccination Date", "definition": "Estimated Flag for Vaccination Date", "comment": "See Mappings", "type": [ { "code": "Extension", "profile": [ "https://ehealthontario.ca/API/FHIR/StructureDefinition/ca-on-extension-estimated-date" ] } ], "mapping": [ { "identity": "source-PHSL", "map": "VM.VACC_DATE_ESTIMATED_IND = 'Y" }, { "identity": "source-PHSL", "map": "note=\"E\"" } ] }, { "id": "Immunization.occurrence[x].extension:_occurrenceDateTime.value[x]", "path": "Immunization.occurrence[x].extension.value[x]", "comment": "Apply PIR: H33_VACCINATION_MASTER.VACC_DATE" }, { "id": "Immunization.location", "path": "Immunization.location", "short": "Immunization Service Delivery Location (SDL)", "definition": "Immunization Service Delivery Location (SDL)", "comment": "See Mappings", "mapping": [ { "identity": "source-PHSL", "map": "serviceDeliveryLocationName" }, { "identity": "source-PIR", "map": "H33_VACCINATION_MASTER.location_id" } ] }, { "id": "Immunization.location.id", "path": "Immunization.location.id", "max": "0" }, { "id": "Immunization.location.reference", "path": "Immunization.location.reference", "comment": "fullURL of Panorama + 'Location' + PIR Loc ID + 'org' + PIR Imms Org ID", "min": 1 }, { "id": "Immunization.location.type", "path": "Immunization.location.type", "max": "0" }, { "id": "Immunization.location.identifier", "path": "Immunization.location.identifier", "max": "0" }, { "id": "Immunization.location.display", "path": "Immunization.location.display", "max": "0" }, { "id": "Immunization.lotNumber", "path": "Immunization.lotNumber", "comment": "See Mappings", "mapping": [ { "identity": "source-PIR", "map": "INV_PRODUCT_LOT_INFO.LOT_NUMBER" }, { "identity": "source-PHSL", "map": "lotNumber" } ] }, { "id": "Immunization.site.id", "path": "Immunization.site.id", "max": "0" }, { "id": "Immunization.site.coding.id", "path": "Immunization.site.coding.id", "max": "0" }, { "id": "Immunization.site.coding.system", "path": "Immunization.site.coding.system", "comment": "Use 'http://snomed.info/sct''" }, { "id": "Immunization.site.coding.version", "path": "Immunization.site.coding.version", "max": "0" }, { "id": "Immunization.site.coding.code", "path": "Immunization.site.coding.code", "comment": "Apply SNOMED code" }, { "id": "Immunization.site.coding.userSelected", "path": "Immunization.site.coding.userSelected", "max": "0" }, { "id": "Immunization.site.text", "path": "Immunization.site.text", "max": "0" }, { "id": "Immunization.route.id", "path": "Immunization.route.id", "max": "0" }, { "id": "Immunization.route.coding.id", "path": "Immunization.route.coding.id", "max": "0" }, { "id": "Immunization.route.coding.system", "path": "Immunization.route.coding.system", "comment": "Use 'http://snomed.info/sct'" }, { "id": "Immunization.route.coding.version", "path": "Immunization.route.coding.version", "max": "0" }, { "id": "Immunization.route.coding.code", "path": "Immunization.route.coding.code", "comment": "Apply SNOMED code" }, { "id": "Immunization.route.coding.userSelected", "path": "Immunization.route.coding.userSelected", "max": "0" }, { "id": "Immunization.route.text", "path": "Immunization.route.text", "max": "0" }, { "id": "Immunization.doseQuantity.id", "path": "Immunization.doseQuantity.id", "max": "0" }, { "id": "Immunization.doseQuantity.value", "path": "Immunization.doseQuantity.value", "comment": "See Mappings", "mapping": [ { "identity": "source-PIR", "map": "H33_VACCINATION_MASTER.CC_VOLUME" }, { "identity": "source-PHSL", "map": "dosage" } ] }, { "id": "Immunization.doseQuantity.unit", "path": "Immunization.doseQuantity.unit", "comment": "See Mappings", "mapping": [ { "identity": "source-PIR", "map": "H33_VACCINATION_MASTER.DOSAGE_UOM_CNCPT_ID" }, { "identity": "source-PHSL", "map": "dosageUOMDescription" } ] }, { "id": "Immunization.doseQuantity.system", "path": "Immunization.doseQuantity.system", "max": "0" }, { "id": "Immunization.doseQuantity.code", "path": "Immunization.doseQuantity.code", "max": "0" }, { "id": "Immunization.performer.actor", "path": "Immunization.performer.actor", "short": "Provider who administered the vaccine", "definition": "Provider who administered the vaccine" }, { "id": "Immunization.performer.actor.reference", "path": "Immunization.performer.actor.reference", "comment": "fullURL of Panorama + 'Practitioner' + PIR Provider ID" }, { "id": "Immunization.note", "path": "Immunization.note", "comment": "See Mappings", "mapping": [ { "identity": "source-PIR", "map": "IMMUNIZATION_COMMENT.COMMENT_TEXT" }, { "identity": "source-PHSL", "map": "commentText" } ] }, { "id": "Immunization.reasonCode", "path": "Immunization.reasonCode", "max": "1" }, { "id": "Immunization.reasonReference", "path": "Immunization.reasonReference", "max": "1" }, { "id": "Immunization.isSubpotent", "path": "Immunization.isSubpotent", "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\".", "comment": "See Mappings", "mapping": [ { "identity": "source-PIR", "map": "PIR imms.vaccine_status.status", "comment": "If invalid, \"1350752\"" }, { "identity": "source-PHSL", "map": "note=\"O\"" } ] }, { "id": "Immunization.subpotentReason", "path": "Immunization.subpotentReason", "short": "Reason + Status for being subpotent", "definition": "Reason why a dose is considered to be subpotent and Status.", "comment": "See Mappings", "mapping": [ { "identity": "source-PIR", "map": "imms.vaccine_status.status_reason" } ] }, { "id": "Immunization.subpotentReason.coding", "path": "Immunization.subpotentReason.coding", "slicing": { "discriminator": [ { "type": "value", "path": "code" } ], "rules": "open" }, "min": 1, "max": "1" }, { "id": "Immunization.subpotentReason.coding:doseStatusReason", "path": "Immunization.subpotentReason.coding", "sliceName": "doseStatusReason", "short": "Slice 1: Dose Status Overriden Reason", "definition": "Dose Status Overriden Reason", "comment": "To be applied when vaccine status = \"OI\", \"OV\".", "max": "1" }, { "id": "Immunization.subpotentReason.coding:doseStatusReason.id", "path": "Immunization.subpotentReason.coding.id", "max": "0" }, { "id": "Immunization.subpotentReason.coding:doseStatusReason.system", "path": "Immunization.subpotentReason.coding.system", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code" } ] }, { "id": "Immunization.subpotentReason.coding:doseStatusReason.code", "path": "Immunization.subpotentReason.coding.code", "min": 1 }, { "id": "Immunization.subpotentReason.coding:doseStatusReason.display", "path": "Immunization.subpotentReason.coding.display", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR-doseStatusReason", "map": "\"Reason - \" + BCYREPORTNG.RBCY_FN_GET_AGENT_STATUS(H33_VACCINATION_MASTER.IMMUNIZATION_ID)" } ] }, { "id": "Immunization.subpotentReason.coding:doseStatus", "path": "Immunization.subpotentReason.coding", "sliceName": "doseStatus", "short": "Dose Status if overriden", "definition": "Dose Status if overriden (from Valid to Invalid) or (from Invalid to Valid)", "min": 1, "max": "1" }, { "id": "Immunization.subpotentReason.coding:doseStatus.system", "path": "Immunization.subpotentReason.coding.system", "comment": "Use 'https://ehealth.bc.ca/fhir/CodeSystem/ca-bc-dose-status'", "min": 1 }, { "id": "Immunization.subpotentReason.coding:doseStatus.code", "path": "Immunization.subpotentReason.coding.code", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "BCYREPORTNG.RBCY_FN_GET_AGENT_STATUS" }, { "identity": "source-PHSL", "map": "agentOverrideStatus" } ] }, { "id": "Immunization.subpotentReason.coding:doseStatus.display", "path": "Immunization.subpotentReason.coding.display", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR-status", "map": "\"Status - \" + BCYREPORTNG.RBCY_FN_GET_AGENT_STATUS (VM.IMMUNIZATION_ID) = 'Valid (override)'" } ] }, { "id": "Immunization.subpotentReason.text", "path": "Immunization.subpotentReason.text", "comment": "To be applied when vaccine status = \"FI\" Forecaster Invalid.\nPIR Forecaster invalidated the imms record for the following possible reasons:\n1. Non-WHO approved tradename\n2. Administered prior to eligibility – interval or age \n3. Additional dose resulting from use of multi-antigen agent\n4. Client administered with same agent on same day" }, { "id": "Immunization.education", "path": "Immunization.education", "max": "1" }, { "id": "Immunization.programEligibility", "path": "Immunization.programEligibility", "max": "1" }, { "id": "Immunization.reaction", "path": "Immunization.reaction", "max": "1" }, { "id": "Immunization.protocolApplied", "path": "Immunization.protocolApplied", "short": "Dose Number or Revised Dose Number", "definition": "Dose Number or Revised Dose Number" }, { "id": "Immunization.protocolApplied.id", "path": "Immunization.protocolApplied.id", "max": "0" }, { "id": "Immunization.protocolApplied.series", "path": "Immunization.protocolApplied.series", "max": "0" }, { "id": "Immunization.protocolApplied.authority", "path": "Immunization.protocolApplied.authority", "max": "0" }, { "id": "Immunization.protocolApplied.targetDisease", "path": "Immunization.protocolApplied.targetDisease", "max": "0" }, { "id": "Immunization.protocolApplied.doseNumber[x]", "path": "Immunization.protocolApplied.doseNumber[x]", "definition": "Nominal position in a series based on Antigen.", "comment": "Dose Number based on Antigen Level. See Mappings", "type": [ { "code": "string" } ], "mapping": [ { "identity": "source-PIR", "map": "BCYREPORTNG.RBCY_FN_GET_AGENT_DOSE_NUM(VM.IMMUNIZATION_ID)" }, { "identity": "source-PHSL", "map": "agentDoseNumber" } ] }, { "id": "Immunization.protocolApplied.doseNumber[x].extension:_doseNumber", "path": "Immunization.protocolApplied.doseNumber[x].extension", "sliceName": "_doseNumber", "short": "Revised Dose Number + Reason + comments", "definition": "Revised Dose Number + Reason + comments", "max": "1", "type": [ { "code": "Extension", "profile": [ "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/immz-revise-dose" ] } ], "isModifier": false }, { "id": "Immunization.protocolApplied.seriesDoses[x]", "path": "Immunization.protocolApplied.seriesDoses[x]", "max": "0" } ] } }