description: Defines a profile representing a vaccination for a SMART Health Card. package_name: hl7.fhir.uv.shc 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: 18 elements: reference: {short: 'This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.', index: 19} type: {index: 20} identifier: {index: 21} display: {index: 22} 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: 35 protocolApplied: {index: 36} meta: 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: 1 vaccineCode: short: Codes identifying the vaccine product administered binding: {strength: example, valueSet: 'http://hl7.org/fhir/uv/shc-vaccination/ValueSet/vaccine-cvx'} mustSupport: true index: 4 elements: coding: mustSupport: true index: 5 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/vaccine-cvx'} index: 6 elements: system: pattern: {type: Uri, value: 'http://hl7.org/fhir/sid/cvx'} index: 7 required: [system] gtin: match: {system: 'https://www.gs1.org/gtin'} schema: short: GTIN code identifying the administered vaccine product binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/shc-vaccination/ValueSet/vaccine-gtin'} index: 8 elements: system: pattern: {type: Uri, value: 'https://www.gs1.org/gtin'} index: 9 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/vaccine-snomed'} index: 10 elements: system: pattern: {type: Uri, value: 'http://snomed.info/sct'} index: 11 required: [system] icd11: match: {system: 'http://id.who.int/icd/release/11/mms'} schema: short: ICD11 code identifying the administered vaccine product binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/shc-vaccination/ValueSet/vaccine-icd-11'} index: 12 elements: system: pattern: {type: Uri, value: 'http://id.who.int/icd/release/11/mms'} index: 13 required: [system] air: match: {system: 'https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats'} schema: short: Australian Immunisation Register Vaccine code identifying the administered vaccine product binding: {strength: required, valueSet: 'https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1'} index: 14 elements: system: pattern: {type: Uri, value: 'https://www.humanservices.gov.au/organisations/health-professionals/enablers/air-vaccine-code-formats'} index: 15 required: [system] atc: match: {system: 'http://www.whocc.no/atc'} schema: short: ATC code identifying the administered vaccine product binding: {strength: required, valueSet: 'http://hl7.org/fhir/uv/shc-vaccination/ValueSet/vaccine-atc'} index: 16 elements: system: pattern: {type: Uri, value: 'http://www.whocc.no/atc'} index: 17 required: [system] required: [coding] statusReason: {index: 3} primarySource: {short: 'Information in this record from person who administered vaccine?', index: 26} status: short: Whether or not the vaccination was completed mustSupport: true pattern: {type: Code, value: completed} index: 2 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: 31 manufacturer: mustSupport: true index: 27 elements: identifier: short: Only populate when vaccine type is not provided in vaccineCode mustSupport: true index: 28 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'')'} mustSupport: true index: 29 value: {mustSupport: true, index: 30} required: [value, system] occurrenceDateTime: constraint: vc-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.toString().matches(''^[0-9]{4}-[0-9]{2}-[0-9]{2}$'')'} type: dateTime mustSupport: true index: 25 occurrence: mustSupport: true choices: [] index: 24 performer: mustSupport: true index: 32 elements: actor: type: Reference short: Organization which was responsible for vaccine administration. mustSupport: true refers: ['http://hl7.org/fhir/StructureDefinition/Organization'] index: 33 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: 34 required: [display] package_version: vaccination-0.6.2 class: profile kind: resource url: http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-ad base: http://hl7.org/fhir/StructureDefinition/Immunization version: 0.6.2 required: [occurrenceDateTime]