ImmunizationRecommendation

The FHIR resource ImmunizationRecommendation is for Forecasting Immunization purposes.

idΣ1..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileΣ1..1canonical(StructureDefinition)
securityΣ0..1CodingBinding
tagΣ0..1Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..1Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
id0..0string
extensionI0..*Extension
codingΣ0..0Coding
textΣ1..1string
systemΣ1..1uri
valueΣ1..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
id0..1string
extensionI0..*Extension
referenceΣ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
dateΣ1..1dateTime
id0..1string
extensionI0..*Extension
referenceΣ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..0string
extensionI0..*Extension
id0..0string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..0string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..0boolean
textΣ0..0string
contraindicatedVaccineCodeΣ0..1CodeableConcept
id0..1string
extensionI0..*Extension
id0..0string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..0string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..0boolean
textΣ0..1string
forecastReasonΣ0..1CodeableConcept
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..0string
extensionI0..*Extension
id0..0string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..0string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..0boolean
textΣ1..1string
value1..1dateTime
description1..1string
series0..1string
doseNumberStringstring
seriesDosesPositiveIntpositiveInt
seriesDosesStringstring
supportingImmunization0..1Reference(Immunization | ImmunizationEvaluation)
supportingPatientInformation0..1Reference(Resource)
ImmunizationRecommendation
DefinitionFHIR resource applies for PIR Vaccine Forecast
Cardinality0...*
Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Request
  • v2: VXU_V04
  • rim: SubstanceAdministration[moodCode=RMD]
ImmunizationRecommendation.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality1...1
Typestring
SummaryTrue
Comments

See Mappings

Mappings
  • source-PIR: H33_VACCINATION_FORECAST.VACCINATION_FORECAST_ID
  • source-PHSL: forecastId
ImmunizationRecommendation.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality1...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ImmunizationRecommendation.meta.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ImmunizationRecommendation.meta.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

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

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

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

Updated: Relax the previously crossed-out elements.

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

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

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

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

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

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

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)
SummaryTrue
Comments

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

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

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

CommonTags (example)
SummaryTrue
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ImmunizationRecommendation.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

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

A human language.

CommonLanguages (preferred)
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ImmunizationRecommendation.text
DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
ImmunizationRecommendation.contained
DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality0...1
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

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

Mappings
  • rim: N/A
ImmunizationRecommendation.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
ImmunizationRecommendation.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
ImmunizationRecommendation.identifier
DefinitionPIR Internal Vaccination Forecast ID
Cardinality1...1
TypeIdentifier
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.identifier
  • w5: FiveWs.identifier
  • rim: .id
ImmunizationRecommendation.identifier.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ImmunizationRecommendation.identifier.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

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

Identifies the purpose for this identifier, if known .

IdentifierUse (required)
ModifierTrue
SummaryTrue
Requirements

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

Comments

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

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

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

Identifier Type Codes (extensible)
SummaryTrue
Requirements

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
ImmunizationRecommendation.identifier.type.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
ImmunizationRecommendation.identifier.type.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

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

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
ImmunizationRecommendation.identifier.type.text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality1...1
Typestring
SummaryTrue
Requirements

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

Comments

See Mappings

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

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

Comments

See Mappings

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

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


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

See Mappings

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

123456


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

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
ImmunizationRecommendation.patient
DefinitionThe patient the recommendation(s) are for.
Cardinality1...1
TypeReference(Patient)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.subject
  • w5: FiveWs.subject[x]
  • v2: PID-3
  • rim: .partipication[typeCode=SUBJ].role
  • w5: FiveWs.subject
ImmunizationRecommendation.patient.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ImmunizationRecommendation.patient.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
ImmunizationRecommendation.patient.reference
DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Cardinality1...1
Typestring
SummaryTrue
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
  • source-PIR: fullURL of Panorama + "Patient" + PIR Client ID
ImmunizationRecommendation.patient.type
DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality0...1
Typeuri
Binding

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

ResourceType (extensible)
SummaryTrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
ImmunizationRecommendation.patient.identifier
DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Cardinality0...1
TypeIdentifier
SummaryTrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

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

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

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

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
ImmunizationRecommendation.date
DefinitionDate Forecast Status Calculated as of
Cardinality1...1
TypedateTime
SummaryTrue
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.authoredOn
  • v2: OBX-15
  • rim: .partipication[typeCode=AUTH].time
  • source-PIR: PIR H33_VACCINATION_FORECAST.CREATED_ON
ImmunizationRecommendation.authority
DefinitionOrganization runs the vaccination forecast
Cardinality1...1
TypeReference(Organization)
Comments

For IDS, Panorama is the organization that runs the vaccination forecast.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX-5 : OBX-3 = 59779-9
  • rim: .participation[typeCode=AUT]
ImmunizationRecommendation.authority.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ImmunizationRecommendation.authority.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
ImmunizationRecommendation.authority.reference
DefinitionA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Cardinality1...1
Typestring
SummaryTrue
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
  • source-PIR: fullURL of Panorama + "Organization" + PIR Organization ID
ImmunizationRecommendation.authority.type
DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality0...1
Typeuri
Binding

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

ResourceType (extensible)
SummaryTrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
ImmunizationRecommendation.authority.identifier
DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Cardinality0...1
TypeIdentifier
SummaryTrue
Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

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

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

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

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
ImmunizationRecommendation.recommendation
DefinitionVaccine forecasted to be administered with different date criterion + targeted disease(s).
Cardinality1...*
TypeBackboneElement
SummaryTrue
Comments

1st instance is the Agent + Antigen(s) + Agent Dates + no Disease, subsequent instances are Antigen + Disease + Disease Dates

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • imr-1: One of vaccineCode or targetDisease SHALL be present
    vaccineCode.exists() or targetDisease.exists()
Mappings
  • rim: .outboundRelationship[typeCode='COMP'].target[classCode=SBADM, moodCode=RMD]
ImmunizationRecommendation.recommendation.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ImmunizationRecommendation.recommendation.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
ImmunizationRecommendation.recommendation.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
ImmunizationRecommendation.recommendation.vaccineCode
DefinitionVaccine(s) or vaccine group that pertain to the recommendation.
Cardinality1...*
TypeCodeableConcept
Binding

The type of vaccine administered.

VaccineAdministeredValueSet (example)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.code
  • v2: OBX-5 : OBX-3 = ( 30956-7 | 38890-0 )
  • rim: .partipication[typeCode=CSM].role[classCode=ADMM].code
ImmunizationRecommendation.recommendation.vaccineCode.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ImmunizationRecommendation.recommendation.vaccineCode.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

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

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

Comments

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

SlicingUnordered, Open, by code(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
ImmunizationRecommendation.recommendation.vaccineCode.coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ImmunizationRecommendation.recommendation.vaccineCode.coding.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

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

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

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
ImmunizationRecommendation.recommendation.vaccineCode.coding.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...1
Typestring
SummaryTrue
Comments

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

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

Need to refer to a particular code in the system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
ImmunizationRecommendation.recommendation.vaccineCode.coding.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...1
Typestring
SummaryTrue
Requirements

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
ImmunizationRecommendation.recommendation.vaccineCode.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
Requirements

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentNVC
DefinitionAgent in CVC code
Cardinality1...1
TypeCoding
SummaryTrue
Requirements

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentNVC.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentNVC.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

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

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

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
  • Code-SNOMED: http://snomed.info/sct
  • Code-NVC: https://nvc-cnv.canada.ca
ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentNVC.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...1
Typestring
SummaryTrue
Comments

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

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

Need to refer to a particular code in the system.

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
  • source-PIR: PIR H33_VACCINATION_FORECAST.FAMILY_CODE
  • source-PHSL: forecastIImmsAgentCode
ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentNVC.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality1...1
Typestring
SummaryTrue
Requirements

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

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
  • source-PIR: REPORTNG.GET_ITERM_DESC(H33_VACCINATION_FORECAST.FAMILY_CODE)
  • source-PHSL: forecastImmsAgentDescription
ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentNVC.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
Requirements

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentPIR
DefinitionAgent in PIR code
Cardinality0...1
TypeCoding
SummaryTrue
Requirements

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

Comments

Agent in PIR code. See Mappings.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentPIR.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentPIR.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

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

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

Comments

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

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

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

Need to refer to a particular code in the system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentPIR.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality1...1
Typestring
SummaryTrue
Requirements

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentPIR.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
Requirements

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenNVC
DefinitionAntigen in NVC code
Cardinality0...1
TypeCoding
SummaryTrue
Requirements

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenNVC.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenNVC.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

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

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

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
  • Code-SNOMED: http://snomed.info/sct
  • Code-NVC: https://nvc-cnv.canada.ca
ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenNVC.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...1
Typestring
SummaryTrue
Comments

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

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

Need to refer to a particular code in the system.

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
  • source-PIR: FORECAST_ANTIGEN.ASIIS_VACC_CODE
  • source-PHSL: Antigen.forecastImmsAntigenCode
ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenNVC.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality1...1
Typestring
SummaryTrue
Requirements

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

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
  • source-PIR: REPORTNG.GET_ITERM_DESC(FORECAST_ANTIGEN.ASIIS_VACC_CODE)
  • source-PHSL: Antigen.forecastImmsAntigenDescription
ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenNVC.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
Requirements

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenPIR
DefinitionAntigen in PIR code
Cardinality0...1
TypeCoding
SummaryTrue
Requirements

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenPIR.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenPIR.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

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

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

Comments

Anitgen in PIR code. See Mappings

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

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

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

Need to refer to a particular code in the system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenPIR.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality1...1
Typestring
SummaryTrue
Requirements

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenPIR.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
Requirements

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
ImmunizationRecommendation.recommendation.vaccineCode.text
DefinitionTrade Name
Cardinality0...1
Typestring
SummaryTrue
Requirements

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

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
  • source-PIR: H33_VACCINATION_FORECAST.TRADE
  • source-PHSL: trade
ImmunizationRecommendation.recommendation.targetDisease
DefinitionThe targeted disease for the recommendation.
Cardinality0...1
TypeCodeableConcept
Binding

The disease that the recommended vaccination targets.

ImmunizationRecommendationTargetDiseaseCodes (example)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX-5 : OBX-3 = ( 30956-7 | 38890-0 )
  • rim: .partipication[typeCode=CSM].role[classCode=ADMM].code
ImmunizationRecommendation.recommendation.targetDisease.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
ImmunizationRecommendation.recommendation.targetDisease.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
ImmunizationRecommendation.recommendation.targetDisease.coding
Definition1st instance Disease in CVC code, 2nd instance Disease in PIR code
Cardinality1...*
TypeCoding
SummaryTrue
Requirements

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

Comments

One Agent can have > 1 antigen, and one agent can have > 1 disease

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
ImmunizationRecommendation.recommendation.targetDisease.coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
ImmunizationRecommendation.recommendation.targetDisease.coding.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
ImmunizationRecommendation.recommendation.targetDisease.coding.system
Definition1st instance: Disease in NVC code. 2nd instance: Disease in PIR code.
Cardinality1...1
Typeuri
SummaryTrue
Requirements

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

Comments

1st instance: Disease in NVC code. 2nd instance: Disease in PIR code. See Mappings

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

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

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

Need to refer to a particular code in the system.

Comments

1st instance Disease in CVC code, 2nd instance Disease in PIR code. See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
  • source-PIR-disease: BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE(DISEASE.DISEASE_CODE_CNCPT_ID)
  • source-PHSL: Antigen.immunizationDiseaseCode
ImmunizationRecommendation.recommendation.targetDisease.coding.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality1...1
Typestring
SummaryTrue
Requirements

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

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
  • source-PIR: REPORTNG.GET_ITERM_DESC(DISEASE.DISEASE_CODE_CNCPT_ID)
  • source-PHSL: Antigen.immunizationDiseaseDescription
ImmunizationRecommendation.recommendation.targetDisease.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...0
Typeboolean
SummaryTrue
Requirements

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
ImmunizationRecommendation.recommendation.targetDisease.text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality0...0
Typestring
SummaryTrue
Requirements

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
ImmunizationRecommendation.recommendation.contraindicatedVaccineCode
DefinitionVaccine(s) which should not be used to fulfill the recommendation.
Cardinality0...1
TypeCodeableConcept
Binding

The type of vaccine administered.

VaccineAdministeredValueSet (example)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
ImmunizationRecommendation.recommendation.forecastStatus
DefinitionIndicates the patient status with respect to the path to immunity for the target disease.
Cardinality1...1
TypeCodeableConcept
Binding

The patient's status with respect to a vaccination protocol.

ImmunizationRecommendationStatusCodes (example)
ModifierTrue
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX-5 : OBX-3 = 59783-1
  • rim: .inboundRelationship[typeCode=SUBJ] .source[classCode=OBS, moodCode=EVN, code="Immunization Forecast Status"].value
ImmunizationRecommendation.recommendation.forecastStatus.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ImmunizationRecommendation.recommendation.forecastStatus.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

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

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
ImmunizationRecommendation.recommendation.forecastStatus.coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
ImmunizationRecommendation.recommendation.forecastStatus.coding.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

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

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

Comments

See Mappings

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

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

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

Need to refer to a particular code in the system.

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
  • source-PIR-calculated-overdue: OVERDUE
  • source-PIR-calculated-due: DUE
  • source-PIR-calculated-eligible: ELIGIBLE
  • source-PIR-calculated-upToDate: UPTODATE
  • source-PIR-calculated-notForecasted: NOTFORECASTED
  • source-PIR-calculated-unknown: UNKNOWN
  • source-PHSL: forecastStatus
ImmunizationRecommendation.recommendation.forecastStatus.coding.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...1
Typestring
SummaryTrue
Requirements

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

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
  • source-PIR-calculated-overdue: Overdue
  • source-PIR-calculated-due: Due
ImmunizationRecommendation.recommendation.forecastStatus.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...0
Typeboolean
SummaryTrue
Requirements

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
ImmunizationRecommendation.recommendation.forecastStatus.text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality0...1
Typestring
SummaryTrue
Requirements

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
ImmunizationRecommendation.recommendation.forecastReason
DefinitionThe reason for the assigned forecast status.
Cardinality0...1
TypeCodeableConcept
Binding

The reason for the patient's status with respect to a vaccination protocol.

ImmunizationRecommendationReasonCodes (example)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX-5 : OBX-3 = 30982-3
  • rim: N/A
ImmunizationRecommendation.recommendation.dateCriterion
DefinitionVaccination date recommendations. For example, earliest date to administer, latest date to administer, etc.
Cardinality1...*
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.occurrence[x]
  • v2: OBX-3: 30980-7 = Next dose recommended, 59777-3 = Latest next dose should be given, 59778-1 = Dose is overdue
  • rim: .outboundRelationship[typeCode='LIMIT'].target[classCode=OBS, moodCode=EVN, isCriterionInd=true]
ImmunizationRecommendation.recommendation.dateCriterion.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ImmunizationRecommendation.recommendation.dateCriterion.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
ImmunizationRecommendation.recommendation.dateCriterion.code
DefinitionDate classification of recommendation. For example, earliest date to give, latest date to give, etc.
Cardinality1...1
TypeCodeableConcept
Binding

Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).

ImmunizationRecommendationDateCriterionCodes (example)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX-3
  • rim: .code
ImmunizationRecommendation.recommendation.dateCriterion.code.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
ImmunizationRecommendation.recommendation.dateCriterion.code.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

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

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
ImmunizationRecommendation.recommendation.dateCriterion.code.coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
ImmunizationRecommendation.recommendation.dateCriterion.code.coding.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

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

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

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

Comments

See Mappings

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

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

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

Need to refer to a particular code in the system.

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
  • source-PIR-eligible-date: 30981-5
  • source-PIR-due-date: 30980-7
  • source-PIR-past-due-date: 59778-1
  • source-PIR-max-date: 59777-3
  • source-PHSL-agent-eligible-date: agentEligibleDate
  • source-PHSL-agent-due-date: agentDueDate
  • source-PHSL-agent-past-due-date: agentPastDueDate
  • source-PHSL-agent-max-date: agentMaxDate
  • source-PHSL-antigen.disease-eligible-date: Antigen.diseaseEligibleDate
  • source-PHSL-antigen-disease-due-date: Antigen.diseaseDueDate
ImmunizationRecommendation.recommendation.dateCriterion.code.coding.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality1...1
Typestring
SummaryTrue
Requirements

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

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
  • source-PIR-eligible-date: Earliest date to give
  • source-PIR-due-date: Date vaccine due
  • source-PIR-past-due-date: Date when overdue for immunization
  • source-PIR-max-date: Latest date to give immunization
ImmunizationRecommendation.recommendation.dateCriterion.code.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...0
Typeboolean
SummaryTrue
Requirements

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

Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
ImmunizationRecommendation.recommendation.dateCriterion.code.text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality1...1
Typestring
SummaryTrue
Requirements

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

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
  • source-PIR-agent-eligible-date: Forecast by Agent Eligible Date
  • source-PIR-agent-due-date: Forecast by Agent Due Date
  • source-PIR-agent-past-due-date: Forecast by Agent Past Due Date
  • source-PIR-agent-max-date: Forecast by Agent Max Date
  • source-PIR-disease-eligible-date: Forecast by Disease Eligible Date
  • source-PIR-disease-due-date: Forecast by Disease Due Date
ImmunizationRecommendation.recommendation.dateCriterion.value
DefinitionThe date whose meaning is specified by dateCriterion.code.
Cardinality1...1
TypedateTime
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX-5
  • rim: .value
  • Date-PastDue: PAST_DUE_DATE in REPORTNG.H33_VACCINATION_FORECAST
  • Date-MaxDate: MAXIMUM_DATE in REPORTNG.H33_VACCINATION_FORECAST
  • Date-Eligible: MINIMUM_DATE in REPORTNG.H33_VACCINATION_FORECAST
  • Date-Due: DUE_DATE in REPORTNG.H33_VACCINATION_FORECAST
  • Date-DiseaseEligibleDate: H33_VACCINATION_FORECAST.MINIMUM_DATE
  • Date-DiseaseDueDate: H33_VACCINATION_FORECAST.DUE_DATE
ImmunizationRecommendation.recommendation.description
DefinitionForecast Agent + Antigen combined description
Cardinality1...1
Typestring
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX-5 : OBX-3 = 30956-7
  • rim: .text
  • source-PIR: BCYREPORTNG.RBCY_T_AGENT_ANTIGENS_COMBINED.ANTIGENS
  • source-PHSL: Antigen.forecastAgentAntigenCombinedDescription
ImmunizationRecommendation.recommendation.series
DefinitionOne possible path to achieve presumed immunity against a disease - within the context of an authority.
Cardinality0...1
Typestring
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: RXA-5-administered code
  • rim: .title
ImmunizationRecommendation.recommendation.doseNumber[x]
DefinitionNominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose).
Cardinality0...1
Typestring
SummaryTrue
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX-5 : OBX-3 = 30973-2
  • rim: .inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=INT]].sequenceNumber
  • source-PIR: PIR h33_vaccination_forecast.Dose_Number
ImmunizationRecommendation.recommendation.seriesDoses[x]
DefinitionThe recommended number of doses to achieve immunity.
Cardinality0...1
TypepositiveInt
Comments

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

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX-5 : OBX-3 = 59782-3
  • rim: .inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=DEF]].sequenceNumber
ImmunizationRecommendation.recommendation.supportingImmunization
DefinitionImmunization event history and/or evaluation that supports the status and recommendation.
Cardinality0...1
TypeReference(Immunization | ImmunizationEvaluation)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: ? No clear way to associate in HL7 v2 or IG
  • rim: .outboundRelationship[typeCode=RSON].target[classCode=SBADM, moodCode=EVN, code="immunization"]
ImmunizationRecommendation.recommendation.supportingPatientInformation
DefinitionPatient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.
Cardinality0...1
TypeReference(Resource)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.supportingInfo
  • v2: OBX If OBX is associated with ( RXA : RXA-5-administered code = '998^No vaccine administered^CVX'), could contain the reason the vaccine was not administered
  • rim: .outboundRelationship[typeCode=RSON].target[classCode=OBS, moodCode=EVN]
<StructureDefinition xmlns="http://hl7.org/fhir">
    <url value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/ImmunizationRecommendation" />
    <name value="ImmunizationRecommendation" />
    <status value="draft" />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="ImmunizationRecommendation" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation" />
    <derivation value="constraint" />
    <differential>
        <element id="ImmunizationRecommendation">
            <path value="ImmunizationRecommendation" />
            <short value="FHIR resource applies for PIR Vaccine Forecast" />
            <definition value="FHIR resource applies for PIR Vaccine Forecast" />
        </element>
        <element id="ImmunizationRecommendation.id">
            <path value="ImmunizationRecommendation.id" />
            <short value="PIR Internal Vaccination Forecast ID" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="H33_VACCINATION_FORECAST.VACCINATION_FORECAST_ID" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="forecastId" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.meta">
            <path value="ImmunizationRecommendation.meta" />
            <min value="1" />
        </element>
        <element id="ImmunizationRecommendation.meta.versionId">
            <path value="ImmunizationRecommendation.meta.versionId" />
            <comment value="Apply &quot;2025.01.1&quot;.  This indicates the FHIR Specs as of year 2025 Jan." />
        </element>
        <element id="ImmunizationRecommendation.meta.lastUpdated">
            <path value="ImmunizationRecommendation.meta.lastUpdated" />
            <comment value="Updated: Relax the previously crossed-out elements." />
        </element>
        <element id="ImmunizationRecommendation.meta.profile">
            <path value="ImmunizationRecommendation.meta.profile" />
            <comment value="Apply &quot;http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/ImmunizationRecommendation&quot;" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="ImmunizationRecommendation.meta.security">
            <path value="ImmunizationRecommendation.meta.security" />
            <max value="1" />
        </element>
        <element id="ImmunizationRecommendation.meta.tag">
            <path value="ImmunizationRecommendation.meta.tag" />
            <max value="1" />
        </element>
        <element id="ImmunizationRecommendation.contained">
            <path value="ImmunizationRecommendation.contained" />
            <max value="1" />
        </element>
        <element id="ImmunizationRecommendation.identifier">
            <path value="ImmunizationRecommendation.identifier" />
            <short value="PIR Internal Vaccination Forecast ID" />
            <definition value="PIR Internal Vaccination Forecast ID" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="ImmunizationRecommendation.identifier.type">
            <path value="ImmunizationRecommendation.identifier.type" />
            <min value="1" />
        </element>
        <element id="ImmunizationRecommendation.identifier.type.id">
            <path value="ImmunizationRecommendation.identifier.type.id" />
            <max value="0" />
        </element>
        <element id="ImmunizationRecommendation.identifier.type.coding">
            <path value="ImmunizationRecommendation.identifier.type.coding" />
            <max value="0" />
        </element>
        <element id="ImmunizationRecommendation.identifier.type.text">
            <path value="ImmunizationRecommendation.identifier.type.text" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="PANORAMAIMMZFORECASTID" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.identifier.system">
            <path value="ImmunizationRecommendation.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-forecaster-id" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.identifier.value">
            <path value="ImmunizationRecommendation.identifier.value" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="H33_VACCINATION_FORECAST.VACCINATION_FORECAST_ID" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="forecastId" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.patient.reference">
            <path value="ImmunizationRecommendation.patient.reference" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="fullURL of Panorama + &quot;Patient&quot; + PIR Client ID" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.date">
            <path value="ImmunizationRecommendation.date" />
            <short value="Date Forecast Status Calculated as of" />
            <definition value="Date Forecast Status Calculated as of" />
            <comment value="See Mappings" />
            <mapping>
                <identity value="source-PIR" />
                <map value="PIR H33_VACCINATION_FORECAST.CREATED_ON" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.authority">
            <path value="ImmunizationRecommendation.authority" />
            <short value="Organization runs the vaccination forecast" />
            <definition value="Organization runs the vaccination forecast" />
            <comment value="For IDS, Panorama is the organization that runs the vaccination forecast." />
            <min value="1" />
        </element>
        <element id="ImmunizationRecommendation.authority.reference">
            <path value="ImmunizationRecommendation.authority.reference" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="fullURL of Panorama + &quot;Organization&quot; + PIR Organization ID" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation">
            <path value="ImmunizationRecommendation.recommendation" />
            <short value="Vaccine forecasted to be administered." />
            <definition value="Vaccine forecasted to be administered with different date criterion + targeted disease(s)." />
            <comment value="1st instance is the Agent + Antigen(s) + Agent Dates + no Disease,  subsequent instances are Antigen + Disease + Disease Dates" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode">
            <path value="ImmunizationRecommendation.recommendation.vaccineCode" />
            <min value="1" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode.coding">
            <path value="ImmunizationRecommendation.recommendation.vaccineCode.coding" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="code" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="1" />
            <max value="1" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode.coding.system">
            <path value="ImmunizationRecommendation.recommendation.vaccineCode.coding.system" />
            <comment value="See Mappings" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentNVC">
            <path value="ImmunizationRecommendation.recommendation.vaccineCode.coding" />
            <sliceName value="AgentNVC" />
            <short value="Agent in CVC code" />
            <definition value="Agent in CVC code" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentNVC.system">
            <path value="ImmunizationRecommendation.recommendation.vaccineCode.coding.system" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="Code-SNOMED" />
                <map value="http://snomed.info/sct" />
            </mapping>
            <mapping>
                <identity value="Code-NVC" />
                <map value="https://nvc-cnv.canada.ca" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentNVC.code">
            <path value="ImmunizationRecommendation.recommendation.vaccineCode.coding.code" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="PIR H33_VACCINATION_FORECAST.FAMILY_CODE" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="forecastIImmsAgentCode" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentNVC.display">
            <path value="ImmunizationRecommendation.recommendation.vaccineCode.coding.display" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="REPORTNG.GET_ITERM_DESC(H33_VACCINATION_FORECAST.FAMILY_CODE)" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="forecastImmsAgentDescription" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentPIR">
            <path value="ImmunizationRecommendation.recommendation.vaccineCode.coding" />
            <sliceName value="AgentPIR" />
            <short value="Agent in PIR code" />
            <definition value="Agent in PIR code" />
            <comment value="Agent in PIR code.  See Mappings." />
            <max value="1" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentPIR.system">
            <path value="ImmunizationRecommendation.recommendation.vaccineCode.coding.system" />
            <min value="1" />
            <mapping>
                <identity value="code-PIR" />
                <map value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentPIR.code">
            <path value="ImmunizationRecommendation.recommendation.vaccineCode.coding.code" />
            <min value="1" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentPIR.display">
            <path value="ImmunizationRecommendation.recommendation.vaccineCode.coding.display" />
            <min value="1" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenNVC">
            <path value="ImmunizationRecommendation.recommendation.vaccineCode.coding" />
            <sliceName value="AntigenNVC" />
            <short value="Antigen in NVC code" />
            <definition value="Antigen in NVC code" />
            <max value="1" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenNVC.system">
            <path value="ImmunizationRecommendation.recommendation.vaccineCode.coding.system" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="Code-SNOMED" />
                <map value="http://snomed.info/sct" />
            </mapping>
            <mapping>
                <identity value="Code-NVC" />
                <map value="https://nvc-cnv.canada.ca" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenNVC.code">
            <path value="ImmunizationRecommendation.recommendation.vaccineCode.coding.code" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="FORECAST_ANTIGEN.ASIIS_VACC_CODE" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="Antigen.forecastImmsAntigenCode" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenNVC.display">
            <path value="ImmunizationRecommendation.recommendation.vaccineCode.coding.display" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="REPORTNG.GET_ITERM_DESC(FORECAST_ANTIGEN.ASIIS_VACC_CODE)" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="Antigen.forecastImmsAntigenDescription" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenPIR">
            <path value="ImmunizationRecommendation.recommendation.vaccineCode.coding" />
            <sliceName value="AntigenPIR" />
            <short value="Antigen in PIR code" />
            <definition value="Antigen in PIR code" />
            <max value="1" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenPIR.system">
            <path value="ImmunizationRecommendation.recommendation.vaccineCode.coding.system" />
            <comment value="Anitgen in PIR code.  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="ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenPIR.code">
            <path value="ImmunizationRecommendation.recommendation.vaccineCode.coding.code" />
            <min value="1" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenPIR.display">
            <path value="ImmunizationRecommendation.recommendation.vaccineCode.coding.display" />
            <min value="1" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.vaccineCode.text">
            <path value="ImmunizationRecommendation.recommendation.vaccineCode.text" />
            <short value="Trade Name" />
            <definition value="Trade Name" />
            <comment value="See Mappings" />
            <mapping>
                <identity value="source-PIR" />
                <map value="H33_VACCINATION_FORECAST.TRADE" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="trade" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.targetDisease.id">
            <path value="ImmunizationRecommendation.recommendation.targetDisease.id" />
            <max value="0" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.targetDisease.coding">
            <path value="ImmunizationRecommendation.recommendation.targetDisease.coding" />
            <short value="1st instance Disease in CVC code, 2nd instance Disease in PIR code" />
            <definition value="1st instance Disease in CVC code, 2nd instance Disease in PIR code" />
            <comment value="One Agent can have &gt; 1 antigen, and one agent can have &gt; 1 disease" />
            <min value="1" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.targetDisease.coding.id">
            <path value="ImmunizationRecommendation.recommendation.targetDisease.coding.id" />
            <max value="0" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.targetDisease.coding.system">
            <path value="ImmunizationRecommendation.recommendation.targetDisease.coding.system" />
            <short value="1st instance: Disease in NVC code.  2nd instance: Disease in PIR code." />
            <definition value="1st instance: Disease in NVC code.  2nd instance: Disease in PIR code." />
            <comment value="1st instance: Disease in NVC code.  2nd instance: Disease in PIR code.  See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="code-NVC" />
                <map value="https://nvc-cnv.canada.ca" />
            </mapping>
            <mapping>
                <identity value="code-PIR" />
                <map value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.targetDisease.coding.version">
            <path value="ImmunizationRecommendation.recommendation.targetDisease.coding.version" />
            <max value="0" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.targetDisease.coding.code">
            <path value="ImmunizationRecommendation.recommendation.targetDisease.coding.code" />
            <comment value="1st instance Disease in CVC code, 2nd instance Disease in PIR code.  See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR-disease" />
                <map value="BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE(DISEASE.DISEASE_CODE_CNCPT_ID)" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="Antigen.immunizationDiseaseCode" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.targetDisease.coding.display">
            <path value="ImmunizationRecommendation.recommendation.targetDisease.coding.display" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="REPORTNG.GET_ITERM_DESC(DISEASE.DISEASE_CODE_CNCPT_ID)" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="Antigen.immunizationDiseaseDescription" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.targetDisease.coding.userSelected">
            <path value="ImmunizationRecommendation.recommendation.targetDisease.coding.userSelected" />
            <max value="0" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.targetDisease.text">
            <path value="ImmunizationRecommendation.recommendation.targetDisease.text" />
            <max value="0" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.contraindicatedVaccineCode">
            <path value="ImmunizationRecommendation.recommendation.contraindicatedVaccineCode" />
            <max value="1" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.forecastStatus">
            <path value="ImmunizationRecommendation.recommendation.forecastStatus" />
            <short value="Vaccination forecast status" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.forecastStatus.coding">
            <path value="ImmunizationRecommendation.recommendation.forecastStatus.coding" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.forecastStatus.coding.id">
            <path value="ImmunizationRecommendation.recommendation.forecastStatus.coding.id" />
            <max value="0" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.forecastStatus.coding.system">
            <path value="ImmunizationRecommendation.recommendation.forecastStatus.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="ImmunizationRecommendation.recommendation.forecastStatus.coding.version">
            <path value="ImmunizationRecommendation.recommendation.forecastStatus.coding.version" />
            <max value="0" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.forecastStatus.coding.code">
            <path value="ImmunizationRecommendation.recommendation.forecastStatus.coding.code" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR-calculated-overdue" />
                <map value="OVERDUE" />
            </mapping>
            <mapping>
                <identity value="source-PIR-calculated-due" />
                <map value="DUE" />
            </mapping>
            <mapping>
                <identity value="source-PIR-calculated-eligible" />
                <map value="ELIGIBLE" />
            </mapping>
            <mapping>
                <identity value="source-PIR-calculated-upToDate" />
                <map value="UPTODATE" />
            </mapping>
            <mapping>
                <identity value="source-PIR-calculated-notForecasted" />
                <map value="NOTFORECASTED" />
            </mapping>
            <mapping>
                <identity value="source-PIR-calculated-unknown" />
                <map value="UNKNOWN" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="forecastStatus" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.forecastStatus.coding.display">
            <path value="ImmunizationRecommendation.recommendation.forecastStatus.coding.display" />
            <comment value="See Mappings" />
            <mapping>
                <identity value="source-PIR-calculated-overdue" />
                <map value="Overdue" />
            </mapping>
            <mapping>
                <identity value="source-PIR-calculated-due" />
                <map value="Due" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.forecastStatus.coding.userSelected">
            <path value="ImmunizationRecommendation.recommendation.forecastStatus.coding.userSelected" />
            <max value="0" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.forecastReason">
            <path value="ImmunizationRecommendation.recommendation.forecastReason" />
            <max value="1" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.dateCriterion">
            <path value="ImmunizationRecommendation.recommendation.dateCriterion" />
            <definition value="Vaccination date recommendations.  For example, earliest date to administer, latest date to administer, etc." />
            <min value="1" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.dateCriterion.code.id">
            <path value="ImmunizationRecommendation.recommendation.dateCriterion.code.id" />
            <max value="0" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.dateCriterion.code.coding">
            <path value="ImmunizationRecommendation.recommendation.dateCriterion.code.coding" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.dateCriterion.code.coding.id">
            <path value="ImmunizationRecommendation.recommendation.dateCriterion.code.coding.id" />
            <max value="0" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.dateCriterion.code.coding.system">
            <path value="ImmunizationRecommendation.recommendation.dateCriterion.code.coding.system" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="http://loinc.org" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.dateCriterion.code.coding.version">
            <path value="ImmunizationRecommendation.recommendation.dateCriterion.code.coding.version" />
            <max value="0" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.dateCriterion.code.coding.code">
            <path value="ImmunizationRecommendation.recommendation.dateCriterion.code.coding.code" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR-eligible-date" />
                <map value="30981-5" />
            </mapping>
            <mapping>
                <identity value="source-PIR-due-date" />
                <map value="30980-7" />
            </mapping>
            <mapping>
                <identity value="source-PIR-past-due-date" />
                <map value="59778-1" />
            </mapping>
            <mapping>
                <identity value="source-PIR-max-date" />
                <map value="59777-3" />
            </mapping>
            <mapping>
                <identity value="source-PHSL-agent-eligible-date" />
                <map value="agentEligibleDate" />
            </mapping>
            <mapping>
                <identity value="source-PHSL-agent-due-date" />
                <map value="agentDueDate" />
            </mapping>
            <mapping>
                <identity value="source-PHSL-agent-past-due-date" />
                <map value="agentPastDueDate" />
            </mapping>
            <mapping>
                <identity value="source-PHSL-agent-max-date" />
                <map value="agentMaxDate" />
            </mapping>
            <mapping>
                <identity value="source-PHSL-antigen.disease-eligible-date" />
                <map value="Antigen.diseaseEligibleDate" />
            </mapping>
            <mapping>
                <identity value="source-PHSL-antigen-disease-due-date" />
                <map value="Antigen.diseaseDueDate" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.dateCriterion.code.coding.display">
            <path value="ImmunizationRecommendation.recommendation.dateCriterion.code.coding.display" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR-eligible-date" />
                <map value="Earliest date to give" />
            </mapping>
            <mapping>
                <identity value="source-PIR-due-date" />
                <map value="Date vaccine due" />
            </mapping>
            <mapping>
                <identity value="source-PIR-past-due-date" />
                <map value="Date when overdue for immunization" />
            </mapping>
            <mapping>
                <identity value="source-PIR-max-date" />
                <map value="Latest date to give immunization" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.dateCriterion.code.coding.userSelected">
            <path value="ImmunizationRecommendation.recommendation.dateCriterion.code.coding.userSelected" />
            <max value="0" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.dateCriterion.code.text">
            <path value="ImmunizationRecommendation.recommendation.dateCriterion.code.text" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR-agent-eligible-date" />
                <map value="Forecast by Agent Eligible Date" />
            </mapping>
            <mapping>
                <identity value="source-PIR-agent-due-date" />
                <map value="Forecast by Agent Due Date" />
            </mapping>
            <mapping>
                <identity value="source-PIR-agent-past-due-date" />
                <map value="Forecast by Agent Past Due Date" />
            </mapping>
            <mapping>
                <identity value="source-PIR-agent-max-date" />
                <map value="Forecast by Agent Max Date" />
            </mapping>
            <mapping>
                <identity value="source-PIR-disease-eligible-date" />
                <map value="Forecast by Disease Eligible Date" />
            </mapping>
            <mapping>
                <identity value="source-PIR-disease-due-date" />
                <map value="Forecast by Disease Due Date" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.dateCriterion.value">
            <path value="ImmunizationRecommendation.recommendation.dateCriterion.value" />
            <comment value="See Mappings" />
            <mapping>
                <identity value="Date-PastDue" />
                <map value="PAST_DUE_DATE in  REPORTNG.H33_VACCINATION_FORECAST" />
            </mapping>
            <mapping>
                <identity value="Date-MaxDate" />
                <map value="MAXIMUM_DATE in REPORTNG.H33_VACCINATION_FORECAST" />
            </mapping>
            <mapping>
                <identity value="Date-Eligible" />
                <map value="MINIMUM_DATE in REPORTNG.H33_VACCINATION_FORECAST" />
            </mapping>
            <mapping>
                <identity value="Date-Due" />
                <map value="DUE_DATE in REPORTNG.H33_VACCINATION_FORECAST" />
            </mapping>
            <mapping>
                <identity value="Date-DiseaseEligibleDate" />
                <map value="H33_VACCINATION_FORECAST.MINIMUM_DATE" />
            </mapping>
            <mapping>
                <identity value="Date-DiseaseDueDate" />
                <map value="H33_VACCINATION_FORECAST.DUE_DATE" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.description">
            <path value="ImmunizationRecommendation.recommendation.description" />
            <short value="Forecast Agent + Antigen combined description" />
            <definition value="Forecast Agent + Antigen combined description" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="BCYREPORTNG.RBCY_T_AGENT_ANTIGENS_COMBINED.ANTIGENS" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="Antigen.forecastAgentAntigenCombinedDescription" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.doseNumber[x]">
            <path value="ImmunizationRecommendation.recommendation.doseNumber[x]" />
            <comment value="See Mappings" />
            <type>
                <code value="string" />
            </type>
            <mapping>
                <identity value="source-PIR" />
                <map value="PIR h33_vaccination_forecast.Dose_Number" />
            </mapping>
        </element>
        <element id="ImmunizationRecommendation.recommendation.supportingImmunization">
            <path value="ImmunizationRecommendation.recommendation.supportingImmunization" />
            <max value="1" />
        </element>
        <element id="ImmunizationRecommendation.recommendation.supportingPatientInformation">
            <path value="ImmunizationRecommendation.recommendation.supportingPatientInformation" />
            <max value="1" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/ImmunizationRecommendation",
    "name": "ImmunizationRecommendation",
    "status": "draft",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "ImmunizationRecommendation",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "ImmunizationRecommendation",
                "path": "ImmunizationRecommendation",
                "short": "FHIR resource applies for PIR Vaccine Forecast",
                "definition": "FHIR resource applies for PIR Vaccine Forecast"
            },
            {
                "id": "ImmunizationRecommendation.id",
                "path": "ImmunizationRecommendation.id",
                "short": "PIR Internal Vaccination Forecast ID",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "H33_VACCINATION_FORECAST.VACCINATION_FORECAST_ID"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "forecastId"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.meta",
                "path": "ImmunizationRecommendation.meta",
                "min": 1
            },
            {
                "id": "ImmunizationRecommendation.meta.versionId",
                "path": "ImmunizationRecommendation.meta.versionId",
                "comment": "Apply \"2025.01.1\".  This indicates the FHIR Specs as of year 2025 Jan."
            },
            {
                "id": "ImmunizationRecommendation.meta.lastUpdated",
                "path": "ImmunizationRecommendation.meta.lastUpdated",
                "comment": "Updated: Relax the previously crossed-out elements."
            },
            {
                "id": "ImmunizationRecommendation.meta.profile",
                "path": "ImmunizationRecommendation.meta.profile",
                "comment": "Apply \"http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/ImmunizationRecommendation\"",
                "min": 1,
                "max": "1"
            },
            {
                "id": "ImmunizationRecommendation.meta.security",
                "path": "ImmunizationRecommendation.meta.security",
                "max": "1"
            },
            {
                "id": "ImmunizationRecommendation.meta.tag",
                "path": "ImmunizationRecommendation.meta.tag",
                "max": "1"
            },
            {
                "id": "ImmunizationRecommendation.contained",
                "path": "ImmunizationRecommendation.contained",
                "max": "1"
            },
            {
                "id": "ImmunizationRecommendation.identifier",
                "path": "ImmunizationRecommendation.identifier",
                "short": "PIR Internal Vaccination Forecast ID",
                "definition": "PIR Internal Vaccination Forecast ID",
                "min": 1,
                "max": "1"
            },
            {
                "id": "ImmunizationRecommendation.identifier.type",
                "path": "ImmunizationRecommendation.identifier.type",
                "min": 1
            },
            {
                "id": "ImmunizationRecommendation.identifier.type.id",
                "path": "ImmunizationRecommendation.identifier.type.id",
                "max": "0"
            },
            {
                "id": "ImmunizationRecommendation.identifier.type.coding",
                "path": "ImmunizationRecommendation.identifier.type.coding",
                "max": "0"
            },
            {
                "id": "ImmunizationRecommendation.identifier.type.text",
                "path": "ImmunizationRecommendation.identifier.type.text",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "PANORAMAIMMZFORECASTID"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.identifier.system",
                "path": "ImmunizationRecommendation.identifier.system",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "https://health.gov.bc.ca/fhir/NamingSystem/ca-bc-panorama-immunization-forecaster-id"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.identifier.value",
                "path": "ImmunizationRecommendation.identifier.value",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "H33_VACCINATION_FORECAST.VACCINATION_FORECAST_ID"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "forecastId"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.patient.reference",
                "path": "ImmunizationRecommendation.patient.reference",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "fullURL of Panorama + \"Patient\" + PIR Client ID"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.date",
                "path": "ImmunizationRecommendation.date",
                "short": "Date Forecast Status Calculated as of",
                "definition": "Date Forecast Status Calculated as of",
                "comment": "See Mappings",
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "PIR H33_VACCINATION_FORECAST.CREATED_ON"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.authority",
                "path": "ImmunizationRecommendation.authority",
                "short": "Organization runs the vaccination forecast",
                "definition": "Organization runs the vaccination forecast",
                "comment": "For IDS, Panorama is the organization that runs the vaccination forecast.",
                "min": 1
            },
            {
                "id": "ImmunizationRecommendation.authority.reference",
                "path": "ImmunizationRecommendation.authority.reference",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "fullURL of Panorama + \"Organization\" + PIR Organization ID"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation",
                "path": "ImmunizationRecommendation.recommendation",
                "short": "Vaccine forecasted to be administered.",
                "definition": "Vaccine forecasted to be administered with different date criterion + targeted disease(s).",
                "comment": "1st instance is the Agent + Antigen(s) + Agent Dates + no Disease,  subsequent instances are Antigen + Disease + Disease Dates"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.vaccineCode",
                "path": "ImmunizationRecommendation.recommendation.vaccineCode",
                "min": 1
            },
            {
                "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding",
                "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "code"
                        }
                    ],
                    "rules": "open"
                },
                "min": 1,
                "max": "1"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding.system",
                "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.system",
                "comment": "See Mappings"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentNVC",
                "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding",
                "sliceName": "AgentNVC",
                "short": "Agent in CVC code",
                "definition": "Agent in CVC code",
                "min": 1,
                "max": "1"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentNVC.system",
                "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.system",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "Code-SNOMED",
                        "map": "http://snomed.info/sct"
                    },
                    {
                        "identity": "Code-NVC",
                        "map": "https://nvc-cnv.canada.ca"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentNVC.code",
                "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.code",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "PIR H33_VACCINATION_FORECAST.FAMILY_CODE"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "forecastIImmsAgentCode"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentNVC.display",
                "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.display",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "REPORTNG.GET_ITERM_DESC(H33_VACCINATION_FORECAST.FAMILY_CODE)"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "forecastImmsAgentDescription"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentPIR",
                "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding",
                "sliceName": "AgentPIR",
                "short": "Agent in PIR code",
                "definition": "Agent in PIR code",
                "comment": "Agent in PIR code.  See Mappings.",
                "max": "1"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentPIR.system",
                "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.system",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "code-PIR",
                        "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentPIR.code",
                "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.code",
                "min": 1
            },
            {
                "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AgentPIR.display",
                "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.display",
                "min": 1
            },
            {
                "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenNVC",
                "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding",
                "sliceName": "AntigenNVC",
                "short": "Antigen in NVC code",
                "definition": "Antigen in NVC code",
                "max": "1"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenNVC.system",
                "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.system",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "Code-SNOMED",
                        "map": "http://snomed.info/sct"
                    },
                    {
                        "identity": "Code-NVC",
                        "map": "https://nvc-cnv.canada.ca"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenNVC.code",
                "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.code",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "FORECAST_ANTIGEN.ASIIS_VACC_CODE"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "Antigen.forecastImmsAntigenCode"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenNVC.display",
                "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.display",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "REPORTNG.GET_ITERM_DESC(FORECAST_ANTIGEN.ASIIS_VACC_CODE)"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "Antigen.forecastImmsAntigenDescription"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenPIR",
                "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding",
                "sliceName": "AntigenPIR",
                "short": "Antigen in PIR code",
                "definition": "Antigen in PIR code",
                "max": "1"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenPIR.system",
                "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.system",
                "comment": "Anitgen in PIR code.  See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "code-PIR",
                        "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenPIR.code",
                "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.code",
                "min": 1
            },
            {
                "id": "ImmunizationRecommendation.recommendation.vaccineCode.coding:AntigenPIR.display",
                "path": "ImmunizationRecommendation.recommendation.vaccineCode.coding.display",
                "min": 1
            },
            {
                "id": "ImmunizationRecommendation.recommendation.vaccineCode.text",
                "path": "ImmunizationRecommendation.recommendation.vaccineCode.text",
                "short": "Trade Name",
                "definition": "Trade Name",
                "comment": "See Mappings",
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "H33_VACCINATION_FORECAST.TRADE"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "trade"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.targetDisease.id",
                "path": "ImmunizationRecommendation.recommendation.targetDisease.id",
                "max": "0"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.targetDisease.coding",
                "path": "ImmunizationRecommendation.recommendation.targetDisease.coding",
                "short": "1st instance Disease in CVC code, 2nd instance Disease in PIR code",
                "definition": "1st instance Disease in CVC code, 2nd instance Disease in PIR code",
                "comment": "One Agent can have > 1 antigen, and one agent can have > 1 disease",
                "min": 1
            },
            {
                "id": "ImmunizationRecommendation.recommendation.targetDisease.coding.id",
                "path": "ImmunizationRecommendation.recommendation.targetDisease.coding.id",
                "max": "0"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.targetDisease.coding.system",
                "path": "ImmunizationRecommendation.recommendation.targetDisease.coding.system",
                "short": "1st instance: Disease in NVC code.  2nd instance: Disease in PIR code.",
                "definition": "1st instance: Disease in NVC code.  2nd instance: Disease in PIR code.",
                "comment": "1st instance: Disease in NVC code.  2nd instance: Disease in PIR code.  See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "code-NVC",
                        "map": "https://nvc-cnv.canada.ca"
                    },
                    {
                        "identity": "code-PIR",
                        "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.targetDisease.coding.version",
                "path": "ImmunizationRecommendation.recommendation.targetDisease.coding.version",
                "max": "0"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.targetDisease.coding.code",
                "path": "ImmunizationRecommendation.recommendation.targetDisease.coding.code",
                "comment": "1st instance Disease in CVC code, 2nd instance Disease in PIR code.  See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR-disease",
                        "map": "BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE(DISEASE.DISEASE_CODE_CNCPT_ID)"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "Antigen.immunizationDiseaseCode"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.targetDisease.coding.display",
                "path": "ImmunizationRecommendation.recommendation.targetDisease.coding.display",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "REPORTNG.GET_ITERM_DESC(DISEASE.DISEASE_CODE_CNCPT_ID)"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "Antigen.immunizationDiseaseDescription"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.targetDisease.coding.userSelected",
                "path": "ImmunizationRecommendation.recommendation.targetDisease.coding.userSelected",
                "max": "0"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.targetDisease.text",
                "path": "ImmunizationRecommendation.recommendation.targetDisease.text",
                "max": "0"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.contraindicatedVaccineCode",
                "path": "ImmunizationRecommendation.recommendation.contraindicatedVaccineCode",
                "max": "1"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.forecastStatus",
                "path": "ImmunizationRecommendation.recommendation.forecastStatus",
                "short": "Vaccination forecast status"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.forecastStatus.coding",
                "path": "ImmunizationRecommendation.recommendation.forecastStatus.coding",
                "min": 1,
                "max": "1"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.forecastStatus.coding.id",
                "path": "ImmunizationRecommendation.recommendation.forecastStatus.coding.id",
                "max": "0"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.forecastStatus.coding.system",
                "path": "ImmunizationRecommendation.recommendation.forecastStatus.coding.system",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.forecastStatus.coding.version",
                "path": "ImmunizationRecommendation.recommendation.forecastStatus.coding.version",
                "max": "0"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.forecastStatus.coding.code",
                "path": "ImmunizationRecommendation.recommendation.forecastStatus.coding.code",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR-calculated-overdue",
                        "map": "OVERDUE"
                    },
                    {
                        "identity": "source-PIR-calculated-due",
                        "map": "DUE"
                    },
                    {
                        "identity": "source-PIR-calculated-eligible",
                        "map": "ELIGIBLE"
                    },
                    {
                        "identity": "source-PIR-calculated-upToDate",
                        "map": "UPTODATE"
                    },
                    {
                        "identity": "source-PIR-calculated-notForecasted",
                        "map": "NOTFORECASTED"
                    },
                    {
                        "identity": "source-PIR-calculated-unknown",
                        "map": "UNKNOWN"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "forecastStatus"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.forecastStatus.coding.display",
                "path": "ImmunizationRecommendation.recommendation.forecastStatus.coding.display",
                "comment": "See Mappings",
                "mapping":  [
                    {
                        "identity": "source-PIR-calculated-overdue",
                        "map": "Overdue"
                    },
                    {
                        "identity": "source-PIR-calculated-due",
                        "map": "Due"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.forecastStatus.coding.userSelected",
                "path": "ImmunizationRecommendation.recommendation.forecastStatus.coding.userSelected",
                "max": "0"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.forecastReason",
                "path": "ImmunizationRecommendation.recommendation.forecastReason",
                "max": "1"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.dateCriterion",
                "path": "ImmunizationRecommendation.recommendation.dateCriterion",
                "definition": "Vaccination date recommendations.  For example, earliest date to administer, latest date to administer, etc.",
                "min": 1
            },
            {
                "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.id",
                "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.id",
                "max": "0"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding",
                "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding",
                "min": 1,
                "max": "1"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.id",
                "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.id",
                "max": "0"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.system",
                "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.system",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "http://loinc.org"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.version",
                "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.version",
                "max": "0"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.code",
                "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.code",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR-eligible-date",
                        "map": "30981-5"
                    },
                    {
                        "identity": "source-PIR-due-date",
                        "map": "30980-7"
                    },
                    {
                        "identity": "source-PIR-past-due-date",
                        "map": "59778-1"
                    },
                    {
                        "identity": "source-PIR-max-date",
                        "map": "59777-3"
                    },
                    {
                        "identity": "source-PHSL-agent-eligible-date",
                        "map": "agentEligibleDate"
                    },
                    {
                        "identity": "source-PHSL-agent-due-date",
                        "map": "agentDueDate"
                    },
                    {
                        "identity": "source-PHSL-agent-past-due-date",
                        "map": "agentPastDueDate"
                    },
                    {
                        "identity": "source-PHSL-agent-max-date",
                        "map": "agentMaxDate"
                    },
                    {
                        "identity": "source-PHSL-antigen.disease-eligible-date",
                        "map": "Antigen.diseaseEligibleDate"
                    },
                    {
                        "identity": "source-PHSL-antigen-disease-due-date",
                        "map": "Antigen.diseaseDueDate"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.display",
                "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.display",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR-eligible-date",
                        "map": "Earliest date to give"
                    },
                    {
                        "identity": "source-PIR-due-date",
                        "map": "Date vaccine due"
                    },
                    {
                        "identity": "source-PIR-past-due-date",
                        "map": "Date when overdue for immunization"
                    },
                    {
                        "identity": "source-PIR-max-date",
                        "map": "Latest date to give immunization"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.userSelected",
                "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding.userSelected",
                "max": "0"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.dateCriterion.code.text",
                "path": "ImmunizationRecommendation.recommendation.dateCriterion.code.text",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR-agent-eligible-date",
                        "map": "Forecast by Agent Eligible Date"
                    },
                    {
                        "identity": "source-PIR-agent-due-date",
                        "map": "Forecast by Agent Due Date"
                    },
                    {
                        "identity": "source-PIR-agent-past-due-date",
                        "map": "Forecast by Agent Past Due Date"
                    },
                    {
                        "identity": "source-PIR-agent-max-date",
                        "map": "Forecast by Agent Max Date"
                    },
                    {
                        "identity": "source-PIR-disease-eligible-date",
                        "map": "Forecast by Disease Eligible Date"
                    },
                    {
                        "identity": "source-PIR-disease-due-date",
                        "map": "Forecast by Disease Due Date"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.dateCriterion.value",
                "path": "ImmunizationRecommendation.recommendation.dateCriterion.value",
                "comment": "See Mappings",
                "mapping":  [
                    {
                        "identity": "Date-PastDue",
                        "map": "PAST_DUE_DATE in  REPORTNG.H33_VACCINATION_FORECAST"
                    },
                    {
                        "identity": "Date-MaxDate",
                        "map": "MAXIMUM_DATE in REPORTNG.H33_VACCINATION_FORECAST"
                    },
                    {
                        "identity": "Date-Eligible",
                        "map": "MINIMUM_DATE in REPORTNG.H33_VACCINATION_FORECAST"
                    },
                    {
                        "identity": "Date-Due",
                        "map": "DUE_DATE in REPORTNG.H33_VACCINATION_FORECAST"
                    },
                    {
                        "identity": "Date-DiseaseEligibleDate",
                        "map": "H33_VACCINATION_FORECAST.MINIMUM_DATE"
                    },
                    {
                        "identity": "Date-DiseaseDueDate",
                        "map": "H33_VACCINATION_FORECAST.DUE_DATE"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.description",
                "path": "ImmunizationRecommendation.recommendation.description",
                "short": "Forecast Agent + Antigen combined description",
                "definition": "Forecast Agent + Antigen combined description",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "BCYREPORTNG.RBCY_T_AGENT_ANTIGENS_COMBINED.ANTIGENS"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "Antigen.forecastAgentAntigenCombinedDescription"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.doseNumber[x]",
                "path": "ImmunizationRecommendation.recommendation.doseNumber[x]",
                "comment": "See Mappings",
                "type":  [
                    {
                        "code": "string"
                    }
                ],
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "PIR h33_vaccination_forecast.Dose_Number"
                    }
                ]
            },
            {
                "id": "ImmunizationRecommendation.recommendation.supportingImmunization",
                "path": "ImmunizationRecommendation.recommendation.supportingImmunization",
                "max": "1"
            },
            {
                "id": "ImmunizationRecommendation.recommendation.supportingPatientInformation",
                "path": "ImmunizationRecommendation.recommendation.supportingPatientInformation",
                "max": "1"
            }
        ]
    }
}