abstractbaseDefinitioncopyrightdate- Values Differ
description- Values Differ
experimentalfhirVersionjurisdiction
jurisdiction[0]kindnamepublisher- Values Differ
purposestatus- Values Differ
titletypeurlversion- Values Differ
| 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.status | Values for status differ: 'active' vs 'draft' |
| Information | StructureDefinition.date | Values for date differ: '2021-08-13T13:26:56+00:00' vs '2023-12-27T21:00:27+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 | StructureDefinition.definition | Values for definition differ: 'A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](http://hl7.org/fhir/R4/provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.' vs 'A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.' |
| Information | StructureDefinition.definition | Values for definition differ: 'A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R4/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R4/structuredefinition-definitions.html#StructureDefinition.url).' vs 'A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).' |
| 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 | 2023-12-27T21:00:27+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 | draft |
|
| 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. | L Type | L Description & Constraints | Comments |
|---|---|---|---|---|---|---|---|---|---|
 Immunization | 0..* | SHCVaccinationAD | Immunization event information | 0..* | SHCVaccinationAD | Immunization event information | |||
 id | Σ | 0..0 | Σ | 0..0 | |||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | SΣ | 0..1 | Meta | Metadata about the resource |
|
 id | 0..0 | 0..0 | |||||||
 Slices for extension | 0..0 | 0..0 | |||||||
| versionId | Σ | 0..0 | Σ | 0..0 | |||||
| lastUpdated | Σ | 0..0 | Σ | 0..0 | |||||
| source | Σ | 0..0 | Σ | 0..0 | |||||
| profile | Σ | 0..0 | Σ | 0..0 | |||||
| security | 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) | |
| tag | Σ | 0..0 | Σ | 0..0 | |||||
| implicitRules | ?!Σ | 0..0 | ?!Σ | 0..0 | |||||
| language | 0..0 | 0..0 | |||||||
| text | 0..0 | 0..0 | |||||||
| contained | 0..0 | 0..0 | |||||||
| extension | 0..0 | 0..0 | |||||||
 modifierExtension | ?! | 0..0 | ?! | 0..0 | |||||
| identifier | 0..0 | 0..0 | |||||||
| status | ?!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 | |
| statusReason | 0..0 | 0..0 | |||||||
| vaccineCode | SΣ | 1..1 | CodeableConcept | Codes identifying the vaccine product administered Binding: ?? (example) | SΣ | 1..1 | CodeableConcept | Codes identifying the vaccine product administered Binding: ?? (example) | |
| id | 0..0 | 0..0 | |||||||
| Slices for extension | 0..0 | 0..0 | |||||||
| Slices for coding | 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 | |
| text | Σ | 0..0 | Σ | 0..0 | |||||
| patient | SΣ | 1..1 | Reference(Patient Profile - General - Allowable Data) | Who was immunized | SΣ | 1..1 | Reference(Patient Profile - General - Allowable Data) | Who was immunized | |
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
| Slices for extension | 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 | |||
| reference | Σ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. | |
| type | Σ | 0..0 | Σ | 0..0 | |||||
| identifier | Σ | 0..0 | Σ | 0..0 | |||||
| display | Σ | 0..0 | Σ | 0..0 | |||||
| encounter | 0..0 | 0..0 | |||||||
| Slices for occurrence[x] | SΣ | 1..1 | dateTime | Vaccine administration date Slice: Unordered, Closed by type:$this | SΣC | 1..1 | dateTime | Vaccine administration date | |
| recorded | 0..0 | 0..0 | |||||||
| primarySource | Σ | 0..0 | Σ | 0..0 | |||||
| reportOrigin | 0..0 | 0..0 | |||||||
| location | 0..0 | 0..0 | |||||||
| manufacturer | S | 0..1 | Reference(Organization) | Vaccine manufacturer | 0..0 |
| |||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
| Slices for extension | 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 | |||
| reference | ΣC | 0..0 | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| ||
| type | Σ | 0..0 | Σ | 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). |
| ||
| identifier | 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 |
|
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
| Slices for extension | 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 | |||
| use | ?!Σ | 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 . | |
| type | Σ | 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. | |
| system | 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 |
|
| value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | Σ | 1..1 | string | The value that is unique Example General: 123456 |
|
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | Σ | 0..1 | Period | Time period when id is/was valid for use | |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| display | Σ | 0..0 | Σ | 0..1 | string | Text alternative for the resource |
| ||
| lotNumber | SC | 0..1 | string | String representing lot number like `0123L45A` | SC | 0..1 | string | String representing lot number like `0123L45A` | |
| expirationDate | 0..0 | 0..0 | |||||||
| site | 0..0 | 0..0 | |||||||
| route | 0..0 | 0..0 | |||||||
| doseQuantity | 0..0 | 0..0 | |||||||
| performer | SΣ | 0..1 | BackboneElement | Who performed event | SΣ | 0..1 | BackboneElement | Who performed event | |
| id | 0..0 | 0..0 | |||||||
| extension | 0..0 | 0..0 | |||||||
| modifierExtension | ?!Σ | 0..0 | ?!Σ | 0..0 | |||||
| function | Σ | 0..0 | Σ | 0..0 | |||||
 actor | SΣ | 1..1 | Reference(Organization) | Organization which was responsible for vaccine administration. | SΣ | 1..1 | Reference(Organization) | Organization which was responsible for vaccine administration. | |
 id | 0..0 | 0..0 | |||||||
| Slices for extension | 0..0 | 0..0 | |||||||
| reference | ΣC | 0..0 | ΣC | 0..0 | |||||
| type | Σ | 0..0 | Σ | 0..0 | |||||
| identifier | Σ | 0..0 | Σ | 0..0 | |||||
| display | 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. | |
| note | Σ | 0..0 | Σ | 0..0 | |||||
| reasonCode | 0..0 | 0..0 | |||||||
| reasonReference | 0..0 | 0..0 | |||||||
| isSubpotent | ?!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 | |
| subpotentReason | 0..0 | 0..0 | |||||||
| education | C | 0..0 | C | 0..0 | |||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| documentType | 0..1 | string | Educational material document identifier | 0..1 | string | Educational material document identifier | |||
| reference | 0..1 | uri | Educational material reference pointer | 0..1 | uri | Educational material reference pointer | |||
| publicationDate | 0..1 | dateTime | Educational material publication date | 0..1 | dateTime | Educational material publication date | |||
| presentationDate | 0..1 | dateTime | Educational material presentation date | 0..1 | dateTime | Educational material presentation date | |||
| programEligibility | 0..0 | 0..0 | |||||||
| fundingSource | 0..0 | 0..0 | |||||||
| reaction | 0..0 | 0..0 | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| date | 0..1 | dateTime | When reaction started | 0..1 | dateTime | When reaction started | |||
| detail | 0..1 | Reference(Observation) | Additional information on reaction | 0..1 | Reference(Observation) | Additional information on reaction | |||
| reported | 0..1 | boolean | Indicates self-reported reaction | 0..1 | boolean | Indicates self-reported reaction | |||
| protocolApplied | 0..0 | 0..0 | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| series | 0..1 | string | Name of vaccine series | 0..1 | string | Name of vaccine series | |||
| authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||
| targetDisease | 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. | |||
| doseNumber[x] | 1..1 | positiveInt, string | Dose number within series | 1..1 | positiveInt, string | Dose number within series | |||
| seriesDoses[x] | 0..1 | positiveInt, string | Recommended number of doses for immunity | 0..1 | positiveInt, string | Recommended number of doses for immunity | |||
| Documentation for this format | |||||||||