description: Defines a [fallback (AD) profile](./profiles.html#conformance-to-profiles) representing a vaccination in a health card.\n\n[See here for implementation details](./vaccination.html).
package_name: hl7.fhir.uv.shc-vaccination
derivation: constraint
name: SHCVaccinationAD
type: Immunization
elements:
  patient:
    type: Reference
    mustSupport: true
    refers: ['http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-patient-general-ad']
    index: 13
    elements:
      reference: {short: 'This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.', index: 14}
      type: {index: 15}
      identifier: {index: 16}
      display: {index: 17}
    required: [reference]
  isSubpotent:
    short: Set to `true` if dose is subpotent; omit otherwise
    constraint:
      vc-shall-be-true-if-populated-invariant: {human: Shall be `true` if populated, source: 'http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-ad', severity: error, expression: $this.exists().not() or $this = true}
    mustSupport: true
    index: 29
  protocolApplied: {index: 30}
  meta:
    mustSupport: true
    index: 1
    elements:
      security:
        short: Limited security label to convey identity level of assurance for patient referenced by this resource.
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/shc-vaccination/ValueSet/identity-assurance-level'}
        mustSupport: true
        index: 2
  vaccineCode:
    short: Codes identifying the vaccine product administered
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/uv/shc-vaccination/ValueSet/immunization-all-cvx'}
    mustSupport: true
    index: 5
    elements:
      coding:
        mustSupport: true
        index: 6
        slicing:
          rules: closed
          description: Slicing based on the code system
          discriminator:
          - {path: system, type: value}
          min: 1
          slices:
            cvx:
              match: {system: 'http://hl7.org/fhir/sid/cvx'}
              schema:
                short: CVX code identifying the administered vaccine product
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/shc-vaccination/ValueSet/immunization-all-cvx'}
                mustSupport: true
                index: 7
                elements:
                  system:
                    pattern: {type: Uri, value: 'http://hl7.org/fhir/sid/cvx'}
                    index: 8
                required: [system]
            snomed:
              match: {system: 'http://snomed.info/sct'}
              schema:
                short: SNOMED CT code identifying the administered vaccine product
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/shc-vaccination/ValueSet/SnomedVaccineCodes'}
                mustSupport: true
                index: 9
                elements:
                  system:
                    pattern: {type: Uri, value: 'http://snomed.info/sct'}
                    index: 10
                required: [system]
            icd11:
              match: {system: 'http://id.who.int/icd/release/11/mms'}
              schema:
                short: ICD-11 MMS code identifying the administered vaccine product
                binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/shc-vaccination/ValueSet/ICD11Codes'}
                mustSupport: true
                index: 11
                elements:
                  system:
                    pattern: {type: Uri, value: 'http://id.who.int/icd/release/11/mms'}
                    index: 12
                required: [system]
    required: [coding]
  statusReason: {index: 4}
  primarySource: {short: 'Information in this record from person who administered vaccine?', index: 21}
  status:
    short: Whether or not the vaccination was completed
    pattern: {type: Code, value: completed}
    mustSupport: true
    index: 3
  id: {short: Should not be populated, index: 0}
  lotNumber:
    short: String representing lot number like `0123L45A`
    constraint:
      vc-should-be-under-20-chars: {human: Length SHOULD be <20 for data minimization., source: 'http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-ad', severity: warning, expression: $this.length() < 20}
      vc-should-not-include-string-lot: {human: 'lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc.', source: 'http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-ad', severity: warning, expression: $this.lower().contains('lot').not()}
    mustSupport: true
    index: 25
  manufacturer:
    elements:
      identifier:
        short: Only populate when vaccine type is not provided in vaccineCode
        index: 22
        elements:
          system:
            short: Code identifying vaccine manufacturer
            constraint:
              shall-use-known-vaccine-manufacturer-code-system: {human: SHALL use a known code system for identifying vaccine manufacturers, source: 'http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-ad', severity: error, expression: '$this.matches(''http://hl7.org/fhir/sid/mvx'') or $this.matches(''https://www.gs1.org/gln'')'}
            index: 23
          value: {index: 24}
        required: [value, system]
  occurrenceDateTime:
    type: dateTime
    constraint:
      vc-polymorphic-date-invariant: {human: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only)., source: 'http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-ad', severity: warning, expression: '($this as dateTime).toString().matches(''^[0-9]{4}-[0-9]{2}-[0-9]{2}$'')'}
    mustSupport: true
    choiceOf: occurrence
    index: 20
  occurrence:
    constraint:
      vc-polymorphic-date-invariant: {human: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only)., source: 'http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-ad', severity: warning, expression: '($this as dateTime).toString().matches(''^[0-9]{4}-[0-9]{2}-[0-9]{2}$'')'}
    mustSupport: true
    choices: [occurrenceDateTime]
    index: 19
  performer:
    mustSupport: true
    index: 26
    elements:
      actor:
        type: Reference
        short: Organization which was responsible for vaccine administration.
        mustSupport: true
        refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
        index: 27
        elements:
          display:
            short: Short, human-readable text representation of the organization.
            constraint:
              vc-should-be-under-30-chars: {human: Length SHOULD be <30 for data minimization., source: 'http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-ad', severity: warning, expression: $this.length() < 30}
            mustSupport: true
            index: 28
        required: [display]
package_version: 1.0.0
class: profile
kind: resource
url: http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-ad
base: http://hl7.org/fhir/StructureDefinition/Immunization
version: 1.0.0