| Left: | Vaccination Profile - Data Minimization (http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-dm) |
| Right: | Vaccination Profile - Data Minimization (http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-dm) |
| Error | StructureDefinition.version | Values for version differ: '0.6.2' vs '1.0.0' |
| Information | StructureDefinition.date | Values for date differ: '2021-08-13T13:26:56+00:00' vs '2026-02-19T00:34:05+00:00' |
| Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 International - Public Health Work Group' vs 'HL7 International / Public Health' |
| Information | StructureDefinition.definition | Values for definition differ: 'For [data minimization reasons](http://hl7.org/fhir/R4/profiles.html#data-minimization), this element SHOULD NOT be populated when generating a resource conforming to this profile for inclusion in one of the Bundles profiled in this IG.' vs 'For [data minimization reasons](profiles.html#data-minimization-and-privacy), this element SHOULD NOT be populated when generating a resource conforming to this profile for inclusion in one of the Bundles profiled in this IG.' |
| Warning | Immunization.meta | Elements differ in definition for mustSupport: 'false' vs 'true' |
| Information | Immunization.language | Example/preferred bindings differ at Immunization.language using binding from SHCVaccinationDM |
| Information | StructureDefinition.definition | Values for definition differ: 'Date vaccine administered.' vs 'Date vaccine administered (`YYYY-MM-DD` format).' |
| Information | StructureDefinition.comment | Values for comment differ: 'See `occurrenceDateTime`.' vs 'For data minimization reasons, only year, month, and date SHOULD be reported for this element. Exact time (hour, minute, second) are not relevant for our use cases.' |
| Warning | Immunization.manufacturer | Elements differ in definition for mustSupport: 'true' vs 'false' |
| Information | Immunization.manufacturer | Element maximum cardinalities differ: '1' vs '0' |
| Information | Immunization.manufacturer.reference | Element maximum cardinalities differ: '0' vs '1' |
| Information | Immunization.manufacturer.type | Element maximum cardinalities differ: '0' vs '1' |
| Warning | Immunization.manufacturer.identifier | Elements differ in definition for mustSupport: 'true' vs 'false' |
| Warning | Immunization.manufacturer.identifier.system | Elements differ in definition for mustSupport: 'true' vs 'false' |
| Warning | Immunization.manufacturer.identifier.value | Elements differ in definition for mustSupport: 'true' vs 'false' |
| Information | Immunization.manufacturer.display | Element maximum cardinalities differ: '0' vs '1' |
| Information | StructureDefinition.comment | Values for comment differ: 'It is critical that Verifiers process this element if it exists and is set to `true`. Therefore, `isSubpotent` is marked as `MustSupport` because it is also flagged with `Is-Modifier`, and per the [conformance requirements](http://hl7.org/fhir/R4/conformance.html), Verifiers SHALL 'meaningfully process' elements that are `MustSupport` and `Is-Modifier`. This element is therefore an exception to the guidance that Issuers must populate `MustSupport` elements if the data are available. An invariant is used to provide a computable representation of this exception: it will produce an error if `isSubpotent = false`, which is the expected value of this element for the vast majority of resources. Because full potency is implicit per this element's definition, we do not want to populate `isSubpotent` with `false` because it increases payload size without adding information. If `isSubpotent` was not allowed at all (`0..0` cardinality), the concern is that resources where `isSubpotent = true` would inadvertently be generated without any indication they were not potent.' vs 'It is critical that Verifiers process this element if it exists and is set to `true`. Therefore, `isSubpotent` is marked as `MustSupport` because it is also flagged with `Is-Modifier`, and per the [conformance requirements](conformance.html), Verifiers SHALL 'meaningfully process' elements that are `MustSupport` and `Is-Modifier`. This element is therefore an exception to the guidance that Issuers must populate `MustSupport` elements if the data are available. An invariant is used to provide a computable representation of this exception: it will produce an error if `isSubpotent = false`, which is the expected value of this element for the vast majority of resources. Because full potency is implicit per this element's definition, we do not want to populate `isSubpotent` with `false` because it increases payload size without adding information. If `isSubpotent` was not allowed at all (`0..0` cardinality), the concern is that resources where `isSubpotent = true` would inadvertently be generated without any indication they were not potent.' |
| Name | Value | Comments | |
|---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-ad | ||
copyright | |||
date | 2021-08-13T13:26:56+00:00 | 2026-02-19T00:34:05+00:00 |
|
description | Defines a profile representing a vaccination for a SMART Health Card. Only elements necessary for Verifiers can be populated. | Defines a [primary (DM) profile](./profiles.html#conformance-to-profiles) representing a vaccination in a health card. [See here for implementation details](./vaccination.html). |
|
experimental | |||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
![]() jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 | ||
kind | resource | ||
name | SHCVaccinationDM | ||
publisher | HL7 International - Public Health Work Group | HL7 International / Public Health |
|
purpose | |||
status | active | ||
title | Vaccination Profile - Data Minimization | ||
type | Immunization | ||
url | http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-dm | ||
version | 0.6.2 | 1.0.0 |
|
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments![]() | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() | 0..* | SHCVaccinationAD | Immunization event information | 0..* | SHCVaccinationAD | Immunization event information | |||||||||||
![]() ![]() | Σ | 0..0 | Should not be populated | Σ | 0..0 | Should not be populated | |||||||||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | SΣ | 0..1 | Meta | Metadata about the resource |
| ||||||||
![]() ![]() ![]() | 0..0 | Unique id for inter-element referencing | 0..0 | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() | 0..0 | Extension Slice: Unordered, Open by value:url | 0..0 | Extension Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() | Σ | 0..0 | Version specific identifier | Σ | 0..0 | Version specific identifier | |||||||||||
![]() ![]() ![]() | Σ | 0..0 | When the resource version last changed | Σ | 0..0 | When the resource version last changed | |||||||||||
![]() ![]() ![]() | Σ | 0..0 | Identifies where the resource comes from | Σ | 0..0 | Identifies where the resource comes from | |||||||||||
![]() ![]() ![]() | Σ | 0..0 | Profiles this resource claims to conform to | Σ | 0..0 | Profiles this resource claims to conform to | |||||||||||
![]() ![]() ![]() | SΣ | 0..1 | Coding | Limited security label to convey identity level of assurance for patient referenced by this resource. Binding: ?? (required) | SΣ | 0..1 | Coding | Limited security label to convey identity level of assurance for patient referenced by this resource. Binding: ?? (required) | |||||||||
![]() ![]() ![]() | Σ | 0..0 | Tags applied to this resource Binding: ?? (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | Σ | 0..0 | Tags applied to this resource Binding: ?? (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||||||||
![]() ![]() | ?!Σ | 0..0 | A set of rules under which this content was created | ?!Σ | 0..0 | A set of rules under which this content was created | |||||||||||
![]() ![]() | 0..0 | Language of the resource content Binding: ?? (preferred): A human language.
| 0..0 | Language of the resource content Binding: ?? (preferred): A human language.
|
| ||||||||||||
![]() ![]() | 0..0 | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | 0..0 | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||
![]() ![]() | 0..0 | Contained, inline Resources | 0..0 | Contained, inline Resources | |||||||||||||
![]() ![]() | 0..0 | Extension | 0..0 | Extension | |||||||||||||
![]() ![]() | ?! | 0..0 | Extension | ?! | 0..0 | Extension | |||||||||||
![]() ![]() | 0..0 | Business identifier | 0..0 | Business identifier | |||||||||||||
![]() ![]() | ?!SΣ | 1..1 | code | Whether or not the vaccination was completed Binding: ?? (required): A set of codes indicating the current status of an Immunization. Required Pattern: completed | ?!SΣ | 1..1 | code | Whether or not the vaccination was completed Binding: ?? (required): A set of codes indicating the current status of an Immunization. Fixed Value: completed | |||||||||
![]() ![]() | 0..0 | Reason not done Binding: ?? (example): The reason why a vaccine was not administered. | 0..0 | Reason not done Binding: ?? (example): The reason why a vaccine was not administered. | |||||||||||||
![]() ![]() | SΣ | 1..1 | CodeableConcept | Codes identifying the vaccine product administered Binding: ?? (example) | SΣ | 1..1 | CodeableConcept | Codes identifying the vaccine product administered Binding: ?? (example) | |||||||||
![]() ![]() ![]() | 0..0 | Unique id for inter-element referencing | 0..0 | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() | 0..0 | Extension Slice: Unordered, Open by value:url | 0..0 | Extension Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() | SΣ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system | SΣ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system | |||||||||
![]() ![]() ![]() | Σ | 0..0 | Plain text representation of the concept | Σ | 0..0 | Plain text representation of the concept | |||||||||||
![]() ![]() | SΣ | 1..1 | Reference(Patient Profile - General - Allowable Data) | Who was immunized | SΣ | 1..1 | Reference(Patient Profile - General - Allowable Data) | Who was immunized | |||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() | ΣC | 1..1 | string | This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle. | ΣC | 1..1 | string | This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle. | |||||||||
![]() ![]() ![]() | Σ | 0..0 | Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). | Σ | 0..0 | Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||||||||
![]() ![]() ![]() | Σ | 0..0 | Logical reference, when literal reference is not known | Σ | 0..0 | Logical reference, when literal reference is not known | |||||||||||
![]() ![]() ![]() | Σ | 0..0 | Text alternative for the resource | Σ | 0..0 | Text alternative for the resource | |||||||||||
![]() ![]() | 0..0 | Encounter immunization was part of | 0..0 | Encounter immunization was part of | |||||||||||||
![]() ![]() | SΣ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this | SΣC | 1..1 | dateTime | Vaccine administration date | |||||||||
![]() ![]() | 0..0 | When the immunization was first captured in the subject's record | 0..0 | When the immunization was first captured in the subject's record | |||||||||||||
![]() ![]() | Σ | 0..0 | Information in this record from person who administered vaccine? | Σ | 0..0 | Information in this record from person who administered vaccine? | |||||||||||
![]() ![]() | 0..0 | Indicates the source of a secondarily reported record Binding: ?? (example): The source of the data for a record which is not from a primary source. | 0..0 | Indicates the source of a secondarily reported record Binding: ?? (example): The source of the data for a record which is not from a primary source. | |||||||||||||
![]() ![]() | 0..0 | Where immunization occurred | 0..0 | Where immunization occurred | |||||||||||||
![]() ![]() | S | 0..1 | Reference(Organization) | Vaccine manufacturer | 0..0 | Vaccine manufacturer |
| ||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() | ΣC | 0..0 | Literal reference, Relative, internal or absolute URL | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| |||||||||
![]() ![]() ![]() | Σ | 0..0 | Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| |||||||||
![]() ![]() ![]() | SΣ | 0..1 | Identifier | Only populate when vaccine type is not provided in vaccineCode | Σ | 0..1 | Identifier | Only populate when vaccine type is not provided in vaccineCode |
| ||||||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known . | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known . | |||||||||
![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | Σ | 0..1 | CodeableConcept | Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||||||
![]() ![]() ![]() ![]() | SΣC | 1..1 | uri | Code identifying vaccine manufacturer Example General: http://www.acme.com/identifiers/patient | ΣC | 1..1 | uri | Code identifying vaccine manufacturer Example General: http://www.acme.com/identifiers/patient |
| ||||||||
![]() ![]() ![]() ![]() | SΣ | 1..1 | string | The value that is unique Example General: 123456 | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| ||||||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use | Σ | 0..1 | Period | Time period when id is/was valid for use | |||||||||
![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||||||
![]() ![]() ![]() | Σ | 0..0 | Text alternative for the resource | Σ | 0..1 | string | Text alternative for the resource |
| |||||||||
![]() ![]() | SC | 0..1 | string | String representing lot number like `0123L45A` | SC | 0..1 | string | String representing lot number like `0123L45A` | |||||||||
![]() ![]() | 0..0 | Vaccine expiration date | 0..0 | Vaccine expiration date | |||||||||||||
![]() ![]() | 0..0 | Body site vaccine was administered Binding: ?? (example): The site at which the vaccine was administered. | 0..0 | Body site vaccine was administered Binding: ?? (example): The site at which the vaccine was administered. | |||||||||||||
![]() ![]() | 0..0 | How vaccine entered body Binding: ?? (example): The route by which the vaccine was administered. | 0..0 | How vaccine entered body Binding: ?? (example): The route by which the vaccine was administered. | |||||||||||||
![]() ![]() | 0..0 | Amount of vaccine administered | 0..0 | Amount of vaccine administered | |||||||||||||
![]() ![]() | SΣ | 0..1 | BackboneElement | Who performed event | SΣ | 0..1 | BackboneElement | Who performed event | |||||||||
![]() ![]() ![]() | 0..0 | Unique id for inter-element referencing | 0..0 | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() | 0..0 | Extension | 0..0 | Extension | |||||||||||||
![]() ![]() ![]() | ?!Σ | 0..0 | Extension | ?!Σ | 0..0 | Extension | |||||||||||
![]() ![]() ![]() | Σ | 0..0 | What type of performance was done Binding: ?? (extensible): The role a practitioner or organization plays in the immunization event. | Σ | 0..0 | What type of performance was done Binding: ?? (extensible): The role a practitioner or organization plays in the immunization event. | |||||||||||
![]() ![]() ![]() | SΣ | 1..1 | Reference(Organization) | Organization which was responsible for vaccine administration. | SΣ | 1..1 | Reference(Organization) | Organization which was responsible for vaccine administration. | |||||||||
![]() ![]() ![]() ![]() | 0..0 | Unique id for inter-element referencing | 0..0 | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() | 0..0 | Extension Slice: Unordered, Open by value:url | 0..0 | Extension Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() ![]() | ΣC | 0..0 | Literal reference, Relative, internal or absolute URL | ΣC | 0..0 | Literal reference, Relative, internal or absolute URL | |||||||||||
![]() ![]() ![]() ![]() | Σ | 0..0 | Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). | Σ | 0..0 | Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||||||||
![]() ![]() ![]() ![]() | Σ | 0..0 | Logical reference, when literal reference is not known | Σ | 0..0 | Logical reference, when literal reference is not known | |||||||||||
![]() ![]() ![]() ![]() | SΣC | 1..1 | string | Short, human-readable text representation of the organization. | SΣC | 1..1 | string | Short, human-readable text representation of the organization. | |||||||||
![]() ![]() | Σ | 0..0 | Additional immunization notes | Σ | 0..0 | Additional immunization notes | |||||||||||
![]() ![]() | 0..0 | Why immunization occurred Binding: ?? (example): The reason why a vaccine was administered. | 0..0 | Why immunization occurred Binding: ?? (example): The reason why a vaccine was administered. | |||||||||||||
![]() ![]() | 0..0 | Why immunization occurred | 0..0 | Why immunization occurred | |||||||||||||
![]() ![]() | ?!SΣC | 0..1 | boolean | Set to `true` if dose is subpotent; omit otherwise | ?!SΣC | 0..1 | boolean | Set to `true` if dose is subpotent; omit otherwise | |||||||||
![]() ![]() | 0..0 | Reason for being subpotent Binding: ?? (example): The reason why a dose is considered to be subpotent. | 0..0 | Reason for being subpotent Binding: ?? (example): The reason why a dose is considered to be subpotent. | |||||||||||||
![]() ![]() | C | 0..0 | Educational material presented to patient | C | 0..0 | Educational material presented to patient | |||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() | 0..1 | string | Educational material document identifier | 0..1 | string | Educational material document identifier | |||||||||||
![]() ![]() ![]() | 0..1 | uri | Educational material reference pointer | 0..1 | uri | Educational material reference pointer | |||||||||||
![]() ![]() ![]() | 0..1 | dateTime | Educational material publication date | 0..1 | dateTime | Educational material publication date | |||||||||||
![]() ![]() ![]() | 0..1 | dateTime | Educational material presentation date | 0..1 | dateTime | Educational material presentation date | |||||||||||
![]() ![]() | 0..0 | Patient eligibility for a vaccination program Binding: ?? (example): The patient's eligibility for a vaccation program. | 0..0 | Patient eligibility for a vaccination program Binding: ?? (example): The patient's eligibility for a vaccation program. | |||||||||||||
![]() ![]() | 0..0 | Funding source for the vaccine Binding: ?? (example): The source of funding used to purchase the vaccine administered. | 0..0 | Funding source for the vaccine Binding: ?? (example): The source of funding used to purchase the vaccine administered. | |||||||||||||
![]() ![]() | 0..0 | Details of a reaction that follows immunization | 0..0 | Details of a reaction that follows immunization | |||||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() | 0..1 | dateTime | When reaction started | 0..1 | dateTime | When reaction started | |||||||||||
![]() ![]() ![]() | 0..1 | Reference(Observation) | Additional information on reaction | 0..1 | Reference(Observation) | Additional information on reaction | |||||||||||
![]() ![]() ![]() | 0..1 | boolean | Indicates self-reported reaction | 0..1 | boolean | Indicates self-reported reaction | |||||||||||
![]() ![]() | 0..0 | Protocol followed by the provider | 0..0 | Protocol followed by the provider | |||||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() | 0..1 | string | Name of vaccine series | 0..1 | string | Name of vaccine series | |||||||||||
![]() ![]() ![]() | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||||||||
![]() ![]() ![]() | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ?? (example): The vaccine preventable disease the dose is being administered for. | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ?? (example): The vaccine preventable disease the dose is being administered for. | |||||||||||
![]() ![]() ![]() | 1..1 | positiveInt, string | Dose number within series | 1..1 | positiveInt, string | Dose number within series | |||||||||||
![]() ![]() ![]() | 0..1 | positiveInt, string | Recommended number of doses for immunity | 0..1 | positiveInt, string | Recommended number of doses for immunity | |||||||||||
Documentation for this format | |||||||||||||||||