ImmunizationRecommendation
type: StructureDefinition
node role: treeRoot
id:
  v: ImmunizationRecommendation
meta:
  last updated:
    v: 2021-01-02T08:58:31.578+11:00
language:
  v: en
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition ImmunizationRecommendation Last updated: 2021-01-02 08:58:31+1100 Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> ImmunizationRecommendation 0..* DomainResource Guidance or advice relating to an immunization Elements defined in Ancestors:id, meta, implicitRules, language, <a href="http://hl7.org/fhir/R5/domainresource.html" title="A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.">text, contained, <a href="http://hl7.org/fhir/R5/domainresource.html" title="May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, 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.">extension, <a href="http://hl7.org/fhir/R5/domainresource.html" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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 …
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-category
    l: structuredefinition-category
  value: String
    v: Clinical.Medications
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
    l: structuredefinition-standards-status
  value: Code
    v: trial-use
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
    l: structuredefinition-fmm
  value: Integer
    v: 3
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category
    l: structuredefinition-security-category
  value: Code
    v: patient
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
    l: structuredefinition-wg
  value: Code
    v: pher
extension:
  url:
    v: http://hl7.org/fhir/build/StructureDefinition/entered-in-error-status
    l: entered-in-error-status
  value: Code
    v: Immunization recommendations are generated on "just in time" and typically are not retained by the system generating them so there isn't an expected workflow where a previous recommendation would be re-evaluated and found to be "in error".
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/additional-resource
    l: additional-resource
  value: Boolean
    v: true
url:
  v: http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation
  l: ImmunizationRecommendation
identifier:
  system:
    v: urn:ietf:rfc:3986
    l: 3986
  value:
    v: urn:oid:2.16.840.1.113883.4.642.5.1232
version:
  v: 0.1.0
name:
  v: ImmunizationRecommendation
title:
  v: Immunization Recommendation
status:
  v: draft
date:
  v: 2021-01-02T08:58:31+11:00
publisher:
  v: HL7 International / Public Health
contact:
  name:
    v: HL7 International / Public Health
  telecom:
    system:
      v: url
    value:
      v: http://www.hl7.org/Special/committees/pher
  telecom:
    system:
      v: email
description:
  v: A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.
jurisdiction:
  coding:
    system:
      v: http://unstats.un.org/unsd/methods/m49/m49.htm
      l: m49.htm
    code:
      v: 001
    display:
      v: World
fhir version:
  v: 6.0.0-ballot3
mapping:
  identity:
    v: workflow
  uri:
    v: http://hl7.org/fhir/workflow
    l: workflow
  name:
    v: Workflow Pattern
mapping:
  identity:
    v: v2
  uri:
    v: http://hl7.org/v2
    l: v2
  name:
    v: HL7 V2 Mapping
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
mapping:
  identity:
    v: w5
  uri:
    v: http://hl7.org/fhir/fivews
    l: fivews
  name:
    v: FiveWs Pattern Mapping
kind:
  v: resource
abstract:
  v: false
type:
  v: ImmunizationRecommendation
  l: ImmunizationRecommendation
base definition:
  v: http://hl7.org/fhir/StructureDefinition/DomainResource
  l: DomainResource
derivation:
  v: specialization
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 6.0.0-ballot3
  element:
    id:
      v: ImmunizationRecommendation
    extension:
      url:
        v: http://hl7.org/fhir/build/StructureDefinition/svg
        l: http://hl7.org/fhir/build/StructureDefinition/svg
      value: Code
        v: 0,0
    path:
      v: ImmunizationRecommendation
    short:
      v: Guidance or advice relating to an immunization
    definition:
      v: A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: DomainResource
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: dom-2
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL NOT contain nested Resources
      expression:
        v: contained.contained.empty()
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        l: DomainResource
    constraint:
      key:
        v: dom-3
      severity:
        v: error
      human:
        v: 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
      expression:
        v: contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        l: DomainResource

key:
  v: dom-4
severity:
  v: error
human:
  v: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
expression:
  v: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
source:
  v: http://hl7.org/fhir/StructureDefinition/DomainResource
  l: DomainResource

key:
  v: dom-5
severity:
  v: error
human:
  v: If a resource is contained in another resource, it SHALL NOT have a security label
expression:
  v: contained.meta.security.empty()
source:
  v: http://hl7.org/fhir/StructureDefinition/DomainResource
  l: DomainResource

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice
    l: elementdefinition-bestpractice
  value: Boolean
    v: true
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation
    l: elementdefinition-bestpractice-explanation
  value: Markdown
    v: When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
key:
  v: dom-6
severity:
  v: warning
human:
  v: A resource should have narrative for robust management
expression:
  v: text.`div`.exists()
source:
  v: http://hl7.org/fhir/StructureDefinition/DomainResource
  l: DomainResource

v: false

v: false

v: false

identity:
  v: workflow
map:
  v: Request

identity:
  v: v2
map:
  v: VXU_V04

identity:
  v: rim
map:
  v: SubstanceAdministration[moodCode=RMD],Entity. Role,or Act,Entity,Role,or Act

identity:
  v: w5
map:
  v: clinical.medication

id:
  v: ImmunizationRecommendation.id
path:
  v: ImmunizationRecommendation.id
short:
  v: Logical id of this artifact
definition:
  v: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
comment:
  v: Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: id
      l: id
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: ImmunizationRecommendation.meta
path:
  v: ImmunizationRecommendation.meta
short:
  v: Metadata about the resource
definition:
  v: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.meta
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Meta
    l: Meta
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: ImmunizationRecommendation.implicitRules
path:
  v: ImmunizationRecommendation.implicitRules
short:
  v: A set of rules under which this content was created
definition:
  v: A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
comment:
  v: 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 its narrative along with other profiles, value sets, etc.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.implicitRules
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: true
is modifier reason:
  v: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
is summary:
  v: true

id:
  v: ImmunizationRecommendation.language
path:
  v: ImmunizationRecommendation.language
short:
  v: Language of the resource content
definition:
  v: The base language in which the resource is written.
comment:
  v: 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).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: Language
  strength:
    v: required
  description:
    v: IETF language tag for a human language
  value set:
    v: http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3
    l: http://hl7.org/fhir/ValueSet/all-languages
  additional:
    purpose:
      v: starter
    value set:
      v: http://hl7.org/fhir/ValueSet/languages|6.0.0-ballot3
      l: http://hl7.org/fhir/ValueSet/languages

id:
  v: ImmunizationRecommendation.text
path:
  v: ImmunizationRecommendation.text
short:
  v: Text summary of the resource, for human interpretation
definition:
  v: A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
comment:
  v: Contained resources do not have a 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.
alias:
  v: narrative
alias:
  v: html
alias:
  v: xhtml
alias:
  v: display
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Narrative
    l: Narrative
condition:
  v: dom-6
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: Act.text?

id:
  v: ImmunizationRecommendation.contained
path:
  v: ImmunizationRecommendation.contained
short:
  v: Contained, inline Resources
definition:
  v: These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
comment:
  v: 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. Contained resources may be a resource type defined in the FHIR specification, or an [additional resource](http://build.fhir.org/resource.html#additional).
alias:
  v: inline resources
alias:
  v: anonymous resources
alias:
  v: contained resources
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.contained
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Resource
    l: Resource
condition:
  v: dom-2
condition:
  v: dom-4
condition:
  v: dom-3
condition:
  v: dom-5
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: ImmunizationRecommendation.extension
path:
  v: ImmunizationRecommendation.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, 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.
comment:
  v: 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.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: ImmunizationRecommendation.modifierExtension
path:
  v: ImmunizationRecommendation.modifierExtension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extensions that cannot be ignored
definition:
  v: May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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).
comment:
  v: 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.
requirements:
  v: 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](http://build.fhir.org/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
must support:
  v: false
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: ImmunizationRecommendation.identifier
path:
  v: ImmunizationRecommendation.identifier
short:
  v: Business identifier
definition:
  v: A unique identifier assigned to this particular recommendation record.
min:
  v: 0
max:
  v: *
base:
  path:
    v: ImmunizationRecommendation.identifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Identifier
    l: Identifier
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.identifier
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.identifier
mapping:
  identity:
    v: rim
  map:
    v: .id

id:
  v: ImmunizationRecommendation.patient
extension:
  url:
    v: http://hl7.org/fhir/build/StructureDefinition/committee-notes
    l: committee-notes
  value: String
    v: PID, PD1, NK1 | #3706.
path:
  v: ImmunizationRecommendation.patient
short:
  v: Who this profile is for
definition:
  v: The patient the recommendation(s) are for.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: ImmunizationRecommendation.patient
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    l: Patient
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.subject
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.subject[x]
mapping:
  identity:
    v: v2
  map:
    v: PID-3
mapping:
  identity:
    v: rim
  map:
    v: .partipication[typeCode=SUBJ].role

id:
  v: ImmunizationRecommendation.date
path:
  v: ImmunizationRecommendation.date
short:
  v: Date recommendation(s) created
definition:
  v: The date the immunization recommendation(s) were created.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: ImmunizationRecommendation.date
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.authoredOn
mapping:
  identity:
    v: v2
  map:
    v: OBX-15
mapping:
  identity:
    v: rim
  map:
    v: .partipication[typeCode=AUTH].time

id:
  v: ImmunizationRecommendation.authority
path:
  v: ImmunizationRecommendation.authority
short:
  v: Who is responsible for schedule
definition:
  v: Indicates the authority who published the schedule (e.g. ACIP, WHO, NITAG).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ImmunizationRecommendation.authority
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    l: Organization
mapping:
  identity:
    v: v2
  map:
    v: OBX-5 : OBX-3 = 59779-9
mapping:
  identity:
    v: rim
  map:
    v: .participation[typeCode=AUT]

id:
  v: ImmunizationRecommendation.recommendation
extension:
  url:
    v: http://hl7.org/fhir/build/StructureDefinition/committee-notes
    l: committee-notes
  value: String
    v: #17773.
extension:
  url:
    v: http://hl7.org/fhir/build/StructureDefinition/svg
    l: http://hl7.org/fhir/build/StructureDefinition/svg
  value: Code
    v: 300,120
path:
  v: ImmunizationRecommendation.recommendation
short:
  v: Vaccine administration recommendations
definition:
  v: Vaccine administration recommendations.
comment:
  v: A given instance of the .recommendation backbone element should correspond to a single recommended administration or the entire immunization series when there is no recommended administration
min:
  v: 1
max:
  v: *
base:
  path:
    v: ImmunizationRecommendation.recommendation
  min:
    v: 1
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
constraint:
  key:
    v: imr-1
  severity:
    v: error
  human:
    v: One of vaccineCode or targetDisease SHALL be present
  expression:
    v: vaccineCode.exists() or targetDisease.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation
    l: ImmunizationRecommendation
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children or both
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode='COMP'].target[classCode=SBADM, moodCode=RMD]

id:
  v: ImmunizationRecommendation.recommendation.id
path:
  v: ImmunizationRecommendation.recommendation.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: id
      l: id
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
condition:
  v: ele-1
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: ImmunizationRecommendation.recommendation.extension
path:
  v: ImmunizationRecommendation.recommendation.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.
comment:
  v: 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.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: ImmunizationRecommendation.recommendation.modifierExtension
path:
  v: ImmunizationRecommendation.recommendation.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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).
comment:
  v: 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.
requirements:
  v: 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](http://build.fhir.org/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: ImmunizationRecommendation.recommendation.vaccineCode
extension:
  url:
    v: http://hl7.org/fhir/build/StructureDefinition/committee-notes
    l: committee-notes
  value: String
    v: #12484.
path:
  v: ImmunizationRecommendation.recommendation.vaccineCode
short:
  v: Vaccine or vaccine group recommendation applies to
definition:
  v: Vaccine(s) or vaccine group that pertain to the recommendation.
min:
  v: 0
max:
  v: *
base:
  path:
    v: ImmunizationRecommendation.recommendation.vaccineCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
condition:
  v: imr-1
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: VaccineCode
  strength:
    v: example
  description:
    v: The type of vaccine administered.
  value set:
    v: http://hl7.org/fhir/ValueSet/vaccine-code
    l: vaccine-code
mapping:
  identity:
    v: workflow
  map:
    v: Request.code
mapping:
  identity:
    v: v2
  map:
    v: OBX-5 : OBX-3 = ( 30956-7 | 38890-0 )
mapping:
  identity:
    v: rim
  map:
    v: .partipication[typeCode=CSM].role[classCode=ADMM].code

id:
  v: ImmunizationRecommendation.recommendation.targetDisease
extension:
  url:
    v: http://hl7.org/fhir/build/StructureDefinition/committee-notes
    l: committee-notes
  value: String
    v: #12484, #17773.
path:
  v: ImmunizationRecommendation.recommendation.targetDisease
short:
  v: Disease to be immunized against
definition:
  v: The targeted disease for the recommendation.
comment:
  v: A given instance of the .recommendation backbone element should correspond to a single recommended administration but sometimes that administration (e.g. MMR) will encompass multiple diseases, thus the targetDisease element is allowed to repeat.
min:
  v: 0
max:
  v: *
base:
  path:
    v: ImmunizationRecommendation.recommendation.targetDisease
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
condition:
  v: imr-1
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: TargetDisease
  strength:
    v: example
  description:
    v: The disease that the recommended vaccination targets.
  value set:
    v: http://hl7.org/fhir/ValueSet/immunization-target-disease
    l: immunization-target-disease
mapping:
  identity:
    v: v2
  map:
    v: OBX-5 : OBX-3 = ( 30956-7 | 38890-0 )
mapping:
  identity:
    v: rim
  map:
    v: .partipication[typeCode=CSM].role[classCode=ADMM].code

id:
  v: ImmunizationRecommendation.recommendation.contraindicatedVaccineCode
path:
  v: ImmunizationRecommendation.recommendation.contraindicatedVaccineCode
short:
  v: Vaccine which is contraindicated to fulfill the recommendation
definition:
  v: Vaccine(s) which should not be used to fulfill the recommendation.
min:
  v: 0
max:
  v: *
base:
  path:
    v: ImmunizationRecommendation.recommendation.contraindicatedVaccineCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: VaccineCode
  strength:
    v: example
  description:
    v: The type of vaccine administered.
  value set:
    v: http://hl7.org/fhir/ValueSet/vaccine-code
    l: vaccine-code

id:
  v: ImmunizationRecommendation.recommendation.forecastStatus
path:
  v: ImmunizationRecommendation.recommendation.forecastStatus
short:
  v: Vaccine recommendation status
definition:
  v: Indicates the patient status with respect to the path to immunity for the target disease.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: ImmunizationRecommendation.recommendation.forecastStatus
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
is modifier:
  v: true
is modifier reason:
  v: This element is labeled as a modifier because the forecastStatus indicates whether a patient needs additional doses (due, overdue, etc.) or not (contraindicated, complete, etc.).
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ImmunizationRecommendationStatus
  strength:
    v: example
  description:
    v: The patient's status with respect to a vaccination protocol.
  value set:
    v: http://hl7.org/fhir/ValueSet/immunization-recommendation-status
    l: immunization-recommendation-status
mapping:
  identity:
    v: v2
  map:
    v: OBX-5 : OBX-3 = 59783-1
mapping:
  identity:
    v: rim
  map:
    v: .inboundRelationship[typeCode=SUBJ] .source[classCode=OBS, moodCode=EVN, code="Immunization Forecast Status"].value

id:
  v: ImmunizationRecommendation.recommendation.forecastReason
path:
  v: ImmunizationRecommendation.recommendation.forecastReason
short:
  v: Vaccine administration status reason
definition:
  v: The reason for the assigned forecast status.
min:
  v: 0
max:
  v: *
base:
  path:
    v: ImmunizationRecommendation.recommendation.forecastReason
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ImmunizationRecommendationReason
  strength:
    v: example
  description:
    v: The reason for the patient's status with respect to a vaccination protocol.
  value set:
    v: http://hl7.org/fhir/ValueSet/immunization-recommendation-reason
    l: immunization-recommendation-reason
mapping:
  identity:
    v: v2
  map:
    v: OBX-5 : OBX-3 = 30982-3
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: ImmunizationRecommendation.recommendation.dateCriterion
extension:
  url:
    v: http://hl7.org/fhir/build/StructureDefinition/svg
    l: http://hl7.org/fhir/build/StructureDefinition/svg
  value: Code
    v: 350,0
path:
  v: ImmunizationRecommendation.recommendation.dateCriterion
short:
  v: Dates governing proposed immunization
definition:
  v: Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.
min:
  v: 0
max:
  v: *
base:
  path:
    v: ImmunizationRecommendation.recommendation.dateCriterion
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children or both
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
mapping:
  identity:
    v: workflow
  map:
    v: Request.occurrence[x]
mapping:
  identity:
    v: v2
  map:
    v: OBX-3: 30980-7 = Next dose recommended, 59777-3 = Latest next dose should be given, 59778-1 = Dose is overdue
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode='LIMIT'].target[classCode=OBS, moodCode=EVN, isCriterionInd=true]

id:
  v: ImmunizationRecommendation.recommendation.dateCriterion.id
path:
  v: ImmunizationRecommendation.recommendation.dateCriterion.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: id
      l: id
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
condition:
  v: ele-1
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: ImmunizationRecommendation.recommendation.dateCriterion.extension
path:
  v: ImmunizationRecommendation.recommendation.dateCriterion.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.
comment:
  v: 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.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension
path:
  v: ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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).
comment:
  v: 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.
requirements:
  v: 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](http://build.fhir.org/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: ImmunizationRecommendation.recommendation.dateCriterion.code
path:
  v: ImmunizationRecommendation.recommendation.dateCriterion.code
short:
  v: Type of date
definition:
  v: Date classification of recommendation. For example, earliest date to give, latest date to give, etc.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: ImmunizationRecommendation.recommendation.dateCriterion.code
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ImmunizationRecommendationDateCriterion
  strength:
    v: example
  description:
    v: Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
  value set:
    v: http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion
    l: immunization-recommendation-date-criterion
mapping:
  identity:
    v: v2
  map:
    v: OBX-3
mapping:
  identity:
    v: rim
  map:
    v: .code

id:
  v: ImmunizationRecommendation.recommendation.dateCriterion.value
path:
  v: ImmunizationRecommendation.recommendation.dateCriterion.value
short:
  v: Recommended date
definition:
  v: The date whose meaning is specified by dateCriterion.code.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: ImmunizationRecommendation.recommendation.dateCriterion.value
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime
mapping:
  identity:
    v: v2
  map:
    v: OBX-5
mapping:
  identity:
    v: rim
  map:
    v: .value

id:
  v: ImmunizationRecommendation.recommendation.description
path:
  v: ImmunizationRecommendation.recommendation.description
short:
  v: Protocol details
definition:
  v: Contains the description about the protocol under which the vaccine was administered.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ImmunizationRecommendation.recommendation.description
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: markdown
    l: markdown
mapping:
  identity:
    v: v2
  map:
    v: OBX-5 : OBX-3 = 30956-7
mapping:
  identity:
    v: rim
  map:
    v: .text

id:
  v: ImmunizationRecommendation.recommendation.series
path:
  v: ImmunizationRecommendation.recommendation.series
short:
  v: Name of vaccination series
definition:
  v: The name of the vaccination series within the context of the authority which defines the series. A series is one possible path to achieve presumed immunity against a disease.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ImmunizationRecommendation.recommendation.series
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: v2
  map:
    v: RXA-5-administered code
mapping:
  identity:
    v: rim
  map:
    v: .title

id:
  v: ImmunizationRecommendation.recommendation.doseNumber
extension:
  url:
    v: http://hl7.org/fhir/build/StructureDefinition/committee-notes
    l: committee-notes
  value: String
    v: #13185 (add option for string), #25277 (restrict to string data type).
path:
  v: ImmunizationRecommendation.recommendation.doseNumber
short:
  v: Recommended dose number within series
definition:
  v: Nominal position of the recommended dose in a series as determined by the evaluation and forecasting process (e.g. dose 2 is the next recommended dose).
comment:
  v: The dose number may be communicated as either a coded concept (for example Dose 1, Dose 2 or Booster) or as free text as needed by the use case.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ImmunizationRecommendation.recommendation.doseNumber
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: DoseNumber
  strength:
    v: example
  description:
    v: A code expressing the vaccine dose number - several coding schemes exist or will be defined for each jurisdiction.
mapping:
  identity:
    v: v2
  map:
    v: OBX-5 : OBX-3 = 30973-2
mapping:
  identity:
    v: rim
  map:
    v: .inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=INT]].sequenceNumber

id:
  v: ImmunizationRecommendation.recommendation.seriesDoses
extension:
  url:
    v: http://hl7.org/fhir/build/StructureDefinition/committee-notes
    l: committee-notes
  value: String
    v: #13185 (add option for string), #25277 (restrict to string data type).
path:
  v: ImmunizationRecommendation.recommendation.seriesDoses
short:
  v: Recommended number of doses for immunity
definition:
  v: The recommended number of doses to achieve immunity as determined by the evaluation and forecasting process.
comment:
  v: The number of doses in a series may be communicated as either a coded concept or as free text as needed by the use case.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ImmunizationRecommendation.recommendation.seriesDoses
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: SeriesDoses
  strength:
    v: example
  description:
    v: A code expressing the doses recommended or expected - several coding schemes exist or will be defined for each jurisdiction.
mapping:
  identity:
    v: v2
  map:
    v: OBX-5 : OBX-3 = 59782-3
mapping:
  identity:
    v: rim
  map:
    v: .inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=DEF]].sequenceNumber

id:
  v: ImmunizationRecommendation.recommendation.supportingImmunization
path:
  v: ImmunizationRecommendation.recommendation.supportingImmunization
short:
  v: Past immunizations supporting recommendation
definition:
  v: Immunization event history and/or evaluation that supports the status and recommendation.
min:
  v: 0
max:
  v: *
base:
  path:
    v: ImmunizationRecommendation.recommendation.supportingImmunization
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Immunization
    l: Immunization
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/ImmunizationEvaluation
    l: ImmunizationEvaluation
mapping:
  identity:
    v: v2
  map:
    v: ? No clear way to associate in HL7 V2 or IG
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode=RSON].target[classCode=SBADM, moodCode=EVN, code="immunization"]

id:
  v: ImmunizationRecommendation.recommendation.supportingPatientInformation
path:
  v: ImmunizationRecommendation.recommendation.supportingPatientInformation
short:
  v: Patient observations supporting recommendation
definition:
  v: Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.
min:
  v: 0
max:
  v: *
base:
  path:
    v: ImmunizationRecommendation.recommendation.supportingPatientInformation
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Resource
    l: Resource
mapping:
  identity:
    v: workflow
  map:
    v: Request.supportingInfo
mapping:
  identity:
    v: v2
  map:
    v: 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
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode=RSON].target[classCode=OBS, moodCode=EVN]

element:
  id:
    v: ImmunizationRecommendation
  extension:
    url:
      v: http://hl7.org/fhir/build/StructureDefinition/svg
      l: http://hl7.org/fhir/build/StructureDefinition/svg
    value: Code
      v: 0,0
  path:
    v: ImmunizationRecommendation
  short:
    v: Guidance or advice relating to an immunization
  definition:
    v: A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.
  min:
    v: 0
  max:
    v: *
  mapping:
    identity:
      v: workflow
    map:
      v: Request
  mapping:
    identity:
      v: v2
    map:
      v: VXU_V04
  mapping:
    identity:
      v: rim
    map:
      v: SubstanceAdministration[moodCode=RMD]
  mapping:
    identity:
      v: w5
    map:
      v: clinical.medication
element:
  id:
    v: ImmunizationRecommendation.identifier
  path:
    v: ImmunizationRecommendation.identifier
  short:
    v: Business identifier
  definition:
    v: A unique identifier assigned to this particular recommendation record.
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: Identifier
      l: Identifier
  is summary:
    v: true
  mapping:
    identity:
      v: workflow
    map:
      v: Request.identifier
  mapping:
    identity:
      v: w5
    map:
      v: FiveWs.identifier
  mapping:
    identity:
      v: rim
    map:
      v: .id
element:
  id:
    v: ImmunizationRecommendation.patient
  extension:
    url:
      v: http://hl7.org/fhir/build/StructureDefinition/committee-notes
      l: committee-notes
    value: String
      v: PID, PD1, NK1 | #3706.
  path:
    v: ImmunizationRecommendation.patient
  short:
    v: Who this profile is for
  definition:
    v: The patient the recommendation(s) are for.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: Reference
      l: Reference
    target profile:
      v: http://hl7.org/fhir/StructureDefinition/Patient
      l: Patient
  is summary:
    v: true
  mapping:
    identity:
      v: workflow
    map:
      v: Request.subject
  mapping:
    identity:
      v: w5
    map:
      v: FiveWs.subject[x]
  mapping:
    identity:
      v: v2
    map:
      v: PID-3
  mapping:
    identity:
      v: rim
    map:
      v: .partipication[typeCode=SUBJ].role
element:
  id:
    v: ImmunizationRecommendation.date
  path:
    v: ImmunizationRecommendation.date
  short:
    v: Date recommendation(s) created
  definition:
    v: The date the immunization recommendation(s) were created.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: dateTime
      l: dateTime
  is summary:
    v: true
  mapping:
    identity:
      v: workflow
    map:
      v: Request.authoredOn
  mapping:
    identity:
      v: v2
    map:
      v: OBX-15
  mapping:
    identity:
      v: rim
    map:
      v: .partipication[typeCode=AUTH].time
element:
  id:
    v: ImmunizationRecommendation.authority
  path:
    v: ImmunizationRecommendation.authority
  short:
    v: Who is responsible for schedule
  definition:
    v: Indicates the authority who published the schedule (e.g. ACIP, WHO, NITAG).
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Reference
      l: Reference
    target profile:
      v: http://hl7.org/fhir/StructureDefinition/Organization
      l: Organization
  mapping:
    identity:
      v: v2
    map:
      v: OBX-5 : OBX-3 = 59779-9
  mapping:
    identity:
      v: rim
    map:
      v: .participation[typeCode=AUT]
element:
  id:
    v: ImmunizationRecommendation.recommendation
  extension:
    url:
      v: http://hl7.org/fhir/build/StructureDefinition/committee-notes
      l: committee-notes
    value: String
      v: #17773.
  extension:
    url:
      v: http://hl7.org/fhir/build/StructureDefinition/svg
      l: http://hl7.org/fhir/build/StructureDefinition/svg
    value: Code
      v: 300,120
  path:
    v: ImmunizationRecommendation.recommendation

v: Vaccine administration recommendations

v: Vaccine administration recommendations.

v: A given instance of the .recommendation backbone element should correspond to a single recommended administration or the entire immunization series when there is no recommended administration

v: 1

v: *

code:
  v: BackboneElement
  l: BackboneElement

key:
  v: imr-1
severity:
  v: error
human:
  v: One of vaccineCode or targetDisease SHALL be present
expression:
  v: vaccineCode.exists() or targetDisease.exists()
source:
  v: http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation
  l: ImmunizationRecommendation

v: true

identity:
  v: rim
map:
  v: .outboundRelationship[typeCode='COMP'].target[classCode=SBADM, moodCode=RMD]

id:
  v: ImmunizationRecommendation.recommendation.vaccineCode
extension:
  url:
    v: http://hl7.org/fhir/build/StructureDefinition/committee-notes
    l: committee-notes
  value: String
    v: #12484.
path:
  v: ImmunizationRecommendation.recommendation.vaccineCode
short:
  v: Vaccine or vaccine group recommendation applies to
definition:
  v: Vaccine(s) or vaccine group that pertain to the recommendation.
min:
  v: 0
max:
  v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
condition:
  v: imr-1
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: VaccineCode
  strength:
    v: example
  description:
    v: The type of vaccine administered.
  value set:
    v: http://hl7.org/fhir/ValueSet/vaccine-code
    l: vaccine-code
mapping:
  identity:
    v: workflow
  map:
    v: Request.code
mapping:
  identity:
    v: v2
  map:
    v: OBX-5 : OBX-3 = ( 30956-7 | 38890-0 )
mapping:
  identity:
    v: rim
  map:
    v: .partipication[typeCode=CSM].role[classCode=ADMM].code

id:
  v: ImmunizationRecommendation.recommendation.targetDisease
extension:
  url:
    v: http://hl7.org/fhir/build/StructureDefinition/committee-notes
    l: committee-notes
  value: String
    v: #12484, #17773.
path:
  v: ImmunizationRecommendation.recommendation.targetDisease
short:
  v: Disease to be immunized against
definition:
  v: The targeted disease for the recommendation.
comment:
  v: A given instance of the .recommendation backbone element should correspond to a single recommended administration but sometimes that administration (e.g. MMR) will encompass multiple diseases, thus the targetDisease element is allowed to repeat.
min:
  v: 0
max:
  v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
condition:
  v: imr-1
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: TargetDisease
  strength:
    v: example
  description:
    v: The disease that the recommended vaccination targets.
  value set:
    v: http://hl7.org/fhir/ValueSet/immunization-target-disease
    l: immunization-target-disease
mapping:
  identity:
    v: v2
  map:
    v: OBX-5 : OBX-3 = ( 30956-7 | 38890-0 )
mapping:
  identity:
    v: rim
  map:
    v: .partipication[typeCode=CSM].role[classCode=ADMM].code

id:
  v: ImmunizationRecommendation.recommendation.contraindicatedVaccineCode
path:
  v: ImmunizationRecommendation.recommendation.contraindicatedVaccineCode
short:
  v: Vaccine which is contraindicated to fulfill the recommendation
definition:
  v: Vaccine(s) which should not be used to fulfill the recommendation.
min:
  v: 0
max:
  v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: VaccineCode
  strength:
    v: example
  description:
    v: The type of vaccine administered.
  value set:
    v: http://hl7.org/fhir/ValueSet/vaccine-code
    l: vaccine-code

id:
  v: ImmunizationRecommendation.recommendation.forecastStatus
path:
  v: ImmunizationRecommendation.recommendation.forecastStatus
short:
  v: Vaccine recommendation status
definition:
  v: Indicates the patient status with respect to the path to immunity for the target disease.
min:
  v: 1
max:
  v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
is modifier:
  v: true
is modifier reason:
  v: This element is labeled as a modifier because the forecastStatus indicates whether a patient needs additional doses (due, overdue, etc.) or not (contraindicated, complete, etc.).
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ImmunizationRecommendationStatus
  strength:
    v: example
  description:
    v: The patient's status with respect to a vaccination protocol.
  value set:
    v: http://hl7.org/fhir/ValueSet/immunization-recommendation-status
    l: immunization-recommendation-status
mapping:
  identity:
    v: v2
  map:
    v: OBX-5 : OBX-3 = 59783-1
mapping:
  identity:
    v: rim
  map:
    v: .inboundRelationship[typeCode=SUBJ] .source[classCode=OBS, moodCode=EVN, code="Immunization Forecast Status"].value

id:
  v: ImmunizationRecommendation.recommendation.forecastReason
path:
  v: ImmunizationRecommendation.recommendation.forecastReason
short:
  v: Vaccine administration status reason
definition:
  v: The reason for the assigned forecast status.
min:
  v: 0
max:
  v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ImmunizationRecommendationReason
  strength:
    v: example
  description:
    v: The reason for the patient's status with respect to a vaccination protocol.
  value set:
    v: http://hl7.org/fhir/ValueSet/immunization-recommendation-reason
    l: immunization-recommendation-reason
mapping:
  identity:
    v: v2
  map:
    v: OBX-5 : OBX-3 = 30982-3
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: ImmunizationRecommendation.recommendation.dateCriterion
extension:
  url:
    v: http://hl7.org/fhir/build/StructureDefinition/svg
    l: http://hl7.org/fhir/build/StructureDefinition/svg
  value: Code
    v: 350,0
path:
  v: ImmunizationRecommendation.recommendation.dateCriterion
short:
  v: Dates governing proposed immunization
definition:
  v: Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.
min:
  v: 0
max:
  v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
mapping:
  identity:
    v: workflow
  map:
    v: Request.occurrence[x]
mapping:
  identity:
    v: v2
  map:
    v: OBX-3: 30980-7 = Next dose recommended, 59777-3 = Latest next dose should be given, 59778-1 = Dose is overdue
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode='LIMIT'].target[classCode=OBS, moodCode=EVN, isCriterionInd=true]

id:
  v: ImmunizationRecommendation.recommendation.dateCriterion.code
path:
  v: ImmunizationRecommendation.recommendation.dateCriterion.code
short:
  v: Type of date
definition:
  v: Date classification of recommendation. For example, earliest date to give, latest date to give, etc.
min:
  v: 1
max:
  v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: ImmunizationRecommendationDateCriterion
  strength:
    v: example
  description:
    v: Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
  value set:
    v: http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion
    l: immunization-recommendation-date-criterion
mapping:
  identity:
    v: v2
  map:
    v: OBX-3
mapping:
  identity:
    v: rim
  map:
    v: .code

id:
  v: ImmunizationRecommendation.recommendation.dateCriterion.value
path:
  v: ImmunizationRecommendation.recommendation.dateCriterion.value
short:
  v: Recommended date
definition:
  v: The date whose meaning is specified by dateCriterion.code.
min:
  v: 1
max:
  v: 1
type:
  code:
    v: dateTime
    l: dateTime
mapping:
  identity:
    v: v2
  map:
    v: OBX-5
mapping:
  identity:
    v: rim
  map:
    v: .value

id:
  v: ImmunizationRecommendation.recommendation.description
path:
  v: ImmunizationRecommendation.recommendation.description
short:
  v: Protocol details
definition:
  v: Contains the description about the protocol under which the vaccine was administered.
min:
  v: 0
max:
  v: 1
type:
  code:
    v: markdown
    l: markdown
mapping:
  identity:
    v: v2
  map:
    v: OBX-5 : OBX-3 = 30956-7
mapping:
  identity:
    v: rim
  map:
    v: .text

id:
  v: ImmunizationRecommendation.recommendation.series
path:
  v: ImmunizationRecommendation.recommendation.series
short:
  v: Name of vaccination series
definition:
  v: The name of the vaccination series within the context of the authority which defines the series. A series is one possible path to achieve presumed immunity against a disease.
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string
    l: string
mapping:
  identity:
    v: v2
  map:
    v: RXA-5-administered code
mapping:
  identity:
    v: rim
  map:
    v: .title

id:
  v: ImmunizationRecommendation.recommendation.doseNumber
extension:
  url:
    v: http://hl7.org/fhir/build/StructureDefinition/committee-notes
    l: committee-notes
  value: String
    v: #13185 (add option for string), #25277 (restrict to string data type).
path:
  v: ImmunizationRecommendation.recommendation.doseNumber
short:
  v: Recommended dose number within series
definition:
  v: Nominal position of the recommended dose in a series as determined by the evaluation and forecasting process (e.g. dose 2 is the next recommended dose).
comment:
  v: The dose number may be communicated as either a coded concept (for example Dose 1, Dose 2 or Booster) or as free text as needed by the use case.
min:
  v: 0
max:
  v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: DoseNumber
  strength:
    v: example
  description:
    v: A code expressing the vaccine dose number - several coding schemes exist or will be defined for each jurisdiction.
mapping:
  identity:
    v: v2
  map:
    v: OBX-5 : OBX-3 = 30973-2
mapping:
  identity:
    v: rim
  map:
    v: .inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=INT]].sequenceNumber

id:
  v: ImmunizationRecommendation.recommendation.seriesDoses
extension:
  url:
    v: http://hl7.org/fhir/build/StructureDefinition/committee-notes
    l: committee-notes
  value: String
    v: #13185 (add option for string), #25277 (restrict to string data type).
path:
  v: ImmunizationRecommendation.recommendation.seriesDoses
short:
  v: Recommended number of doses for immunity
definition:
  v: The recommended number of doses to achieve immunity as determined by the evaluation and forecasting process.
comment:
  v: The number of doses in a series may be communicated as either a coded concept or as free text as needed by the use case.
min:
  v: 0
max:
  v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: SeriesDoses
  strength:
    v: example
  description:
    v: A code expressing the doses recommended or expected - several coding schemes exist or will be defined for each jurisdiction.
mapping:
  identity:
    v: v2
  map:
    v: OBX-5 : OBX-3 = 59782-3
mapping:
  identity:
    v: rim
  map:
    v: .inboundRelationship[typeCode=COMP, .source[classCode=SBADM, moodCode=DEF]].sequenceNumber

id:
  v: ImmunizationRecommendation.recommendation.supportingImmunization
path:
  v: ImmunizationRecommendation.recommendation.supportingImmunization
short:
  v: Past immunizations supporting recommendation
definition:
  v: Immunization event history and/or evaluation that supports the status and recommendation.
min:
  v: 0
max:
  v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Immunization
    l: Immunization
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/ImmunizationEvaluation
    l: ImmunizationEvaluation
mapping:
  identity:
    v: v2
  map:
    v: ? No clear way to associate in HL7 V2 or IG
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode=RSON].target[classCode=SBADM, moodCode=EVN, code="immunization"]

id:
  v: ImmunizationRecommendation.recommendation.supportingPatientInformation
path:
  v: ImmunizationRecommendation.recommendation.supportingPatientInformation
short:
  v: Patient observations supporting recommendation
definition:
  v: Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.
min:
  v: 0
max:
  v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Resource
    l: Resource
mapping:
  identity:
    v: workflow
  map:
    v: Request.supportingInfo
mapping:
  identity:
    v: v2
  map:
    v: 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
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode=RSON].target[classCode=OBS, moodCode=EVN]