Left: | DDCC Immunization (http://smart.who.int/ddcc/StructureDefinition/DDCCImmunization) |
Right: | DDCC Immunization (http://smart.who.int/ddcc/StructureDefinition/DDCCImmunization) |
Error | StructureDefinition.version | Values for version differ: '1.0.0' vs '1.0.1' |
Information | StructureDefinition.status | Values for status differ: 'draft' vs 'active' |
Information | StructureDefinition.date | Values for date differ: '2024-10-15T11:00:36+02:00' vs '2024-12-18T16:46:48+01:00' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips | ||
copyright | |||
date | 2024-10-15T11:00:36+02:00 | 2024-12-18T16:46:48+01:00 |
|
description | A DDCC Immunization contains the content corresponding to a row in the Vaccination Events section of a Paper DDCC. While this is not a further profile of the International Patient Summary (IPS) Immunization resouce, this is intended to map into an IPS Immunization resource. | ||
experimental | |||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 | ||
kind | resource | ||
name | DDCCImmunization | ||
publisher | WHO | ||
purpose | |||
status | draft | active |
|
title | DDCC Immunization | ||
type | Immunization | ||
url | http://smart.who.int/ddcc/StructureDefinition/DDCCImmunization | ||
version | 1.0.0 | 1.0.1 |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Immunization | 0..* | ImmunizationUvIps | Immunization event information | 0..* | ImmunizationUvIps | Immunization event information | |||||||||||||||||||||||||||
id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||||||||||||||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||||||||||||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||||||||
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||||||||||||||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||||||||||||||||||
contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||||||||||||||||||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||||||||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||||||
identifier | 0..* | Identifier | Business identifier | 0..* | Identifier | Business identifier | |||||||||||||||||||||||||||
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ?? (required): A set of codes indicating the current status of an Immunization. | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ?? (required): A set of codes indicating the current status of an Immunization. | |||||||||||||||||||||||||
statusReason | 0..1 | CodeableConcept | Reason not done Binding: ?? (example): The reason why a vaccine was not administered. | 0..1 | CodeableConcept | Reason not done Binding: ?? (example): The reason why a vaccine was not administered. | |||||||||||||||||||||||||||
vaccineCode | S | 1..1 | ?? | Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided.
The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code.
Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. Binding: ?? (preferred)
| S | 1..1 | ?? | Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided.
The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code.
Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product. Binding: ?? (preferred)
| |||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||
coding | S | 1..1 | ?? | A reference to a code defined by a terminology system | S | 1..1 | ?? | A reference to a code defined by a terminology system | |||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||
system | SΣ | 1..1 | uri | Identity of the terminology system | SΣ | 1..1 | uri | Identity of the terminology system | |||||||||||||||||||||||||
version | Σ | 0..1 | string | Version of the system - if relevant | Σ | 0..1 | string | Version of the system - if relevant | |||||||||||||||||||||||||
code | SΣ | 1..1 | code | Symbol in syntax defined by the system | SΣ | 1..1 | code | Symbol in syntax defined by the system | |||||||||||||||||||||||||
display | SΣ | 0..1 | string | Representation defined by the system | SΣ | 0..1 | string | Representation defined by the system | |||||||||||||||||||||||||
id | 0..1 | string | xml:id (or equivalent in JSON) | 0..1 | string | xml:id (or equivalent in JSON) | |||||||||||||||||||||||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||||||||||||||||
value | 0..1 | string | Primitive value for string Max Length:1048576 | 0..1 | string | Primitive value for string Max Length:1048576 | |||||||||||||||||||||||||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | Σ | 0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||||||||||||||
text | SΣ | 0..1 | string | Plain text representation of the concept | SΣ | 0..1 | string | Plain text representation of the concept | |||||||||||||||||||||||||
patient | SΣ | 1..1 | Reference(DDCC Patient) | Who was immunized | SΣ | 1..1 | Reference(DDCC Patient) | 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 | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | |||||||||||||||||||||||||
type | Σ | 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). | Σ | 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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | |||||||||||||||||||||||||
display | Σ | 0..1 | string | Text alternative for the resource | Σ | 0..1 | string | Text alternative for the resource | |||||||||||||||||||||||||
encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | 0..1 | Reference(Encounter) | Encounter immunization was part of | |||||||||||||||||||||||||||
occurrence[x] | SΣ | 1..1 | dateTime | Vaccine administration date | SΣ | 1..1 | dateTime | Vaccine administration date | |||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||
recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||||||||||||||||||||||||
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in | Σ | 0..1 | boolean | Indicates context the data was recorded in | |||||||||||||||||||||||||
reportOrigin | 0..1 | CodeableConcept | 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..1 | CodeableConcept | 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. | |||||||||||||||||||||||||||
location | S | 1..1 | Reference(Location) | Where immunization occurred | S | 1..1 | Reference(Location) | Where immunization occurred | |||||||||||||||||||||||||
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..1 | string | Literal reference, Relative, internal or absolute URL | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | |||||||||||||||||||||||||
type | Σ | 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). | Σ | 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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | |||||||||||||||||||||||||
display | SΣ | 1..1 | string | Text alternative for the resource | SΣ | 1..1 | string | Text alternative for the resource | |||||||||||||||||||||||||
manufacturer | S | 0..1 | Reference(Organization) | Vaccine manufacturer | S | 0..1 | Reference(Organization) | Vaccine manufacturer | |||||||||||||||||||||||||
lotNumber | S | 0..1 | string | Vaccine lot number | S | 0..1 | string | Vaccine lot number | |||||||||||||||||||||||||
expirationDate | 0..1 | date | Vaccine expiration date | 0..1 | date | Vaccine expiration date | |||||||||||||||||||||||||||
site | 0..1 | ?? | Concept - reference to a terminology or just text Binding: ?? (preferred) | 0..1 | ?? | Concept - reference to a terminology or just text Binding: ?? (preferred) | |||||||||||||||||||||||||||
route | 0..1 | ?? | Concept - reference to a terminology or just text Binding: ?? (preferred) | 0..1 | ?? | Concept - reference to a terminology or just text Binding: ?? (preferred) | |||||||||||||||||||||||||||
doseQuantity | 0..1 | ?? | Amount of vaccine administered | 0..1 | ?? | Amount of vaccine administered | |||||||||||||||||||||||||||
performer | Σ | 0..* | BackboneElement | Who performed event | Σ | 0..* | BackboneElement | Who performed event | |||||||||||||||||||||||||
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 | |||||||||||||||||||||||||
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ?? (extensible): The role a practitioner or organization plays in the immunization event. | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ?? (extensible): The role a practitioner or organization plays in the immunization event. | |||||||||||||||||||||||||
actor | Σ | 1..1 | Reference(DDCC Practitioner | DDCC Organization) | Individual or organization who was performing | Σ | 1..1 | Reference(DDCC Practitioner | DDCC Organization) | Individual or organization who was performing | |||||||||||||||||||||||||
note | Σ | 0..* | Annotation | Additional immunization notes | Σ | 0..* | Annotation | Additional immunization notes | |||||||||||||||||||||||||
reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: ?? (example): The reason why a vaccine was administered. | 0..* | CodeableConcept | Why immunization occurred Binding: ?? (example): The reason why a vaccine was administered. | |||||||||||||||||||||||||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||||||||||||||||||||||||
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ?!Σ | 0..1 | boolean | Dose potency | |||||||||||||||||||||||||
subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: ?? (example): The reason why a dose is considered to be subpotent. | 0..* | CodeableConcept | Reason for being subpotent Binding: ?? (example): The reason why a dose is considered to be subpotent. | |||||||||||||||||||||||||||
education | C | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present | C | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present | |||||||||||||||||||||||||
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..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ?? (example): The patient's eligibility for a vaccation program. | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ?? (example): The patient's eligibility for a vaccation program. | |||||||||||||||||||||||||||
fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ?? (example): The source of funding used to purchase the vaccine administered. | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ?? (example): The source of funding used to purchase the vaccine administered. | |||||||||||||||||||||||||||
reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||||||||||||||||||||||||
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 | |||||||||||||||||||||||||||
Slices for protocolApplied | S | 1..* | BackboneElement | Protocol followed by the provider Slice: Unordered, Open by type:authority | S | 1..* | BackboneElement | Protocol followed by the provider Slice: Unordered, Open by type:authority | |||||||||||||||||||||||||
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 preventable disease being targeted Binding: ?? (preferred): The particular disease or diseases against which the patient has been immunized.
| 0..* | CodeableConcept | Vaccine preventable disease being targeted Binding: ?? (preferred): The particular disease or diseases against which the patient has been immunized.
| |||||||||||||||||||||||||||
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 |