HL7 FHIR Implementation Guide: DK Core
3.8.0 - ci-build Denmark flag

HL7 FHIR Implementation Guide: DK Core, published by HL7 Denmark. This guide is not an authorized publication; it is the continuous build for version 3.8.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7dk/dk-core/ and changes regularly. See the Directory of published versions

Resource Profile: Danish Core Immunization Profile

Official URL: http://hl7.dk/fhir/core/StructureDefinition/dk-core-immunization Version: 3.8.0
Active as of 2026-11-18 Computable Name: DkCoreImmunization

HL7 Denmark core profile for an administered vaccination, aligned with Det Danske Vaccinationsregister (DDV)

Scope and usage

The Danish Core Immunization profile represents an administered vaccination — a dose that was actually given. Like the other dk-core profiles it is not bound to a particular source system: any Danish system that records an administered vaccination can exchange it with this profile.

Det Danske Vaccinationsregister (DDV) is the central, authoritative register of vaccinations in Denmark, and in practice most vaccination data exchanged in a Danish context either originates from or is reported to DDV. Everything that follows specifically from that — how the DDV elements are carried, and which parts of the DDV data model cannot be represented at all — is collected in Det Danske Vaccinationsregister (DDV) at the bottom of this page, so that the general documentation of the profile stays system-independent.

Status

The profile represents administered vaccinations, so in practice only two of the status values occur:

  • completed — the vaccination was administered.
  • entered-in-error — the registration has been retracted or deleted.

status = #not-done together with statusReason is how FHIR expresses that a vaccination was not given. A source system that only records administered vaccinations cannot produce that combination, and it cannot be derived after the fact. Consumers must therefore not infer a refusal or an omission from the absence of an Immunization resource.

Confidentiality and private-marking

In Denmark, a citizen may choose to private-mark a specific vaccination. A private-marked vaccination is administered on equal footing with every other registration — private-marking is not a refusal and does not change status. It means only that the record must not be made visible unless the responsible health professional invokes værdispring (break-the-glass) or holds the citizen's consent.

This is modelled the same way dk-core marks confidential data on DkCorePatient: a security label

meta.security = http://terminology.hl7.org/CodeSystem/v3-Confidentiality#R   // "Restricted"

A private-marked vaccination is a complete registration. It carries the same elements — performer, lotNumber (aka batch number), notes — as any other vaccination; only its visibility differs. Implementers must not treat private-marking as a reason to strip data from the resource.

Two points are deliberately left to the implementer, because a profile cannot express them:

  • Consuming-application behaviour. Systems consuming dk-core Immunization resources are expected to treat a #R (Restricted) security label as a private-mark: signal to the clinician that something is hidden, suppress it from normal display, and release it only under værdispring or consent. The profile can label the data, but it cannot enforce this behaviour in the consuming application.
  • The access threshold itself. This profile intentionally does not — and cannot — define when værdispring is legitimate. That threshold follows from Sundhedsloven and the guidance of the responsible authorities, not from the profile. Nobody should assume the profile covers it.

Private-marking affects what an individual clinician sees, not what the register knows: a private-marked vaccination still counts fully in vaccination coverage statistics.

Vaccination courses and next dose

protocolApplied carries the vaccination course or series that an administration is part of.

A computable "next dose due" is not part of this profile, and it should not be added as an extension — for interval or multi-dose vaccines such as Twinrix that information is clinically important, but modelling it on the Immunization resource is not compliant FHIR design. Immunization records a dose that was given; a dose that is due is a plan. The recommended design is:

  • organise the vaccination treatment as a whole in a plan element — a ServiceRequest or a CarePlan;
  • link each Immunization (the doses actually given) to that plan. FHIR R4 Immunization has no element for referencing a plan (basedOn only exists from R5), so the link is made from the plan side, e.g. CarePlan.activity.outcomeReference pointing to the Immunization;
  • have an Encounter or Appointment (the next dose) reference the same plan.

This is an implementation concern rather than a profile concern, and it is documented here so that implementers do not reach for an extension on Immunization instead.

Vaccine coding

The vaccine is carried as free text in vaccineCode.text together with up to three codings, sliced on vaccineCode.coding:

  • ATC — the WHO ATC code. The ATC code must descend from J07, given that J07 functions as the root supertype concept for vaccines in the ATC classification. This is enforced, not merely stated: the slice carries a required binding to VaccineATCCodes, which is the intensional expansion of everything under J07, so a non-vaccine ATC code fails validation.
  • SCTVaccineCode — a SNOMED CT code for the vaccine, which MAY be added where known.
  • DdvVaccine — the numeric vaccine identifier assigned by Statens Serum Institut and used in DDV; see the Mappings tab.

Target diseases are carried in protocolApplied.targetDisease, each with its own coding.

Many of the non-mandatory data elements inherited from the generic FHIR Immunization resource remain optional here and will only be populated in certain cases.


Det Danske Vaccinationsregister (DDV)

This section is DDV-specific. It documents how the Danish national vaccination register maps onto the profile, and is relevant only when the vaccination originates from — or is reported to — DDV. Nothing in this section constrains an implementation that does not use DDV.

Authoritative DDV XML schemas are published at wiki.fmk-teknik.dk/fmk:ddv:extensions:e1 with target namespace http://vaccinationsregister.dk/schemas/2013/12/01 (interface 1.4.0 + extension E1). Service delivery is described at nspop.dk. The complete field-by-field mapping is published on the Mappings tab of this profile, which is the single source of truth for it; this section only covers the points where the DDV data model has a consequence for the profile.

Administered vaccinations, and why planned ones are out of scope

DDV exposes administered vaccinations (Vaccinations) and recommended/planned vaccinations (PlannedVaccinations) through separate services. Only administered vaccinations are in scope for this profile; planned vaccinations are outside the scope of the Danish Core Immunization profile.

This is also what makes status = #not-done / statusReason underivable in a DDV context: a citizen who declines or omits a recommended vaccination leaves no Vaccination record — a refusal is never written there — and the history of PlannedVaccinations cannot be retrieved via the interface, so the refusal cannot be inferred from the planned side either.

Where the field-level mapping lives

The element-by-element correspondence — ActiveStatus as a deletion marker (and Slettet credibility), VaccinationVersionIdentifier and meta.versionId, NegativeConsentIndicator as private-marking, BatchNumber, the effectuator fields, EffectuatedPlannedItem and CoverageDuration, IsPrevious / VaccinationCredibility / ConfirmedByPrescriptionServer, and the unmapped SSIDrug — is documented on the Mappings tab and is not repeated here. Note that:

  • A DDV Vaccination is always an administered vaccination, and a private-marked one is not a refusal and does not change status — see Confidentiality and private-marking.
  • DDV, as the centrally governed system of record, carries responsibility for traceability of adverse events and product defects.
  • CoverageDuration is not a substitute for a plan element and must not be parsed as a computable "next dose due" — see Vaccination courses and next dose.

Identifying DDV as the source system

A registration sourced from DDV should carry

meta.source = http://vaccinationsregister.dk/schemas/2013/12/01

the authoritative DDV XML schema namespace. DDV does not publish a separate canonical URI for the register as a system, so the schema namespace serves as its identifier; this is the same root the DDV identifier and coding systems are built on.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Immunization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Immunization.Slices for identifier 0..* Identifier Business identifier
Slice: Unordered, Open by value:system
Immunization.Slices for identifier.identifier:DdvVaccinationId 0..1 Identifier [DA] DDV vaccinationsid
Immunization.Slices for identifier.identifier:DdvVaccinationId.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Immunization.Slices for identifier.identifier:DdvVaccinationId.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: http://vaccinationsregister.dk/schemas/2013/12/01/VaccinationIdentifier (no extensions allowed)
Immunization.Slices for identifier.identifier:DdvVaccinationId.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code Status of the vaccination - an administered vaccination is completed
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason 0..1 CodeableConcept Reason the vaccination was not administered - not used by this profile as its unsupported by DDV
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
Immunization.vaccineCode This element is included in summaries. 1..1 CodeableConcept Vaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Immunization.vaccineCode.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
Immunization.vaccineCode.Slices for coding.coding:ATC This element is included in summaries. 0..1 Coding WHO ATC code for the vaccine, descending from J07
Binding: DK Vaccine ATC Codes (required)
Immunization.vaccineCode.Slices for coding.coding:ATC.system This element is included in summaries. 1..1 uri Identity of the terminology system
Fixed Value: http://www.whocc.no/atc (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:ATC.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode This element is included in summaries. 0..1 Coding SNOMED CT code for the vaccine
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct (extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine This element is included in summaries. 0..1 Coding [DA] DDV vaccineid
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.system This element is included in summaries. 1..1 uri Identity of the terminology system
Fixed Value: http://vaccinationsregister.dk/schemas/2013/12/01/VaccineIdentifier (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Immunization.vaccineCode.text This element is included in summaries. 0..1 string Plain text representation of the concept
Immunization.patient This element is included in summaries. 1..1 Reference(Danish Core Patient Profile) Who was immunized
Immunization.occurrence[x] This element is included in summaries. 1..1 Vaccine administration date
Immunization.occurrence[x].occurrenceDateTime dateTime
Immunization.occurrence[x].occurrenceString string
Immunization.recorded 0..1 dateTime When the immunization was first captured in the subject's record
Immunization.primarySource This element is included in summaries. 0..1 boolean Whether the record was captured by the party that administered the vaccination
Immunization.reportOrigin 0..1 CodeableConcept Source of the record when it was not captured by the administering party
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
Immunization.lotNumber 0..1 string Vaccine lot number. Also known as batch number
Immunization.note This element is included in summaries. 0..* Annotation Additional information about the vaccination without a dedicated element
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency
Immunization.protocolApplied 0..* BackboneElement Vaccination course or series that the administration is part of
Immunization.protocolApplied.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.protocolApplied.targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Immunization.protocolApplied.doseNumber[x] 1..1 Dose number within series
Immunization.protocolApplied.doseNumber[x].doseNumberPositiveInt positiveInt
Immunization.protocolApplied.doseNumber[x].doseNumberString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.identifier:DdvVaccinationId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.statusReason Base example Immunization Status Reason Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
Immunization.vaccineCode.​coding:ATC Base required DK Vaccine ATC Codes 📦3.8.0 This IG
Immunization.reportOrigin Base example Immunization Origin Codes 📍4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.meta
Immunization.meta.versionId 0..1 id Version specific identifier
Immunization.meta.source 0..1 uri Register or system the vaccination was recorded in, where one can be identified
Immunization.meta.security 0..* Coding [DA] Privatmarkering
Immunization.Slices for identifier 0..* Identifier Business identifier
Slice: Unordered, Open by value:system
Immunization.Slices for identifier.identifier:DdvVaccinationId 0..1 Identifier [DA] DDV vaccinationsid
Immunization.Slices for identifier.identifier:DdvVaccinationId.system 1..1 uri The namespace for the identifier value
Fixed Value: http://vaccinationsregister.dk/schemas/2013/12/01/VaccinationIdentifier (no extensions allowed)
Immunization.Slices for identifier.identifier:DdvVaccinationId.value 1..1 string The value that is unique
Immunization.status 1..1 code Status of the vaccination - an administered vaccination is completed
Immunization.vaccineCode 1..1 CodeableConcept Vaccine product administered
Immunization.vaccineCode.Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
Immunization.vaccineCode.Slices for coding.coding:ATC 0..1 Coding WHO ATC code for the vaccine, descending from J07
Binding: DK Vaccine ATC Codes (required)
Immunization.vaccineCode.Slices for coding.coding:ATC.system 1..1 uri Identity of the terminology system
Fixed Value: http://www.whocc.no/atc (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:ATC.code 1..1 code Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode 0..1 Coding SNOMED CT code for the vaccine
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.system 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct (extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.code 1..1 code Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine 0..1 Coding [DA] DDV vaccineid
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.system 1..1 uri Identity of the terminology system
Fixed Value: http://vaccinationsregister.dk/schemas/2013/12/01/VaccineIdentifier (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.code 1..1 code Symbol in syntax defined by the system
Immunization.vaccineCode.text 0..1 string Plain text representation of the concept
Immunization.patient 1..1 Reference(Danish Core Patient Profile) Who was immunized
Immunization.occurrence[x] 1..1 dateTime, string Vaccine administration date
Immunization.recorded 0..1 dateTime When the immunization was first captured in the subject's record
Immunization.primarySource 0..1 boolean Whether the record was captured by the party that administered the vaccination
Immunization.reportOrigin 0..1 CodeableConcept Source of the record when it was not captured by the administering party
Immunization.lotNumber 0..1 string Vaccine lot number. Also known as batch number
Immunization.performer
Immunization.performer.actor 1..1 Reference(Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Organization Profile) Who administered the vaccination - a structured reference is preferred over a free-text display
Immunization.note 0..* Annotation Additional information about the vaccination without a dedicated element
Immunization.protocolApplied 0..* BackboneElement Vaccination course or series that the administration is part of
Immunization.protocolApplied.targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.vaccineCode.​coding:ATC Base required DK Vaccine ATC Codes 📦3.8.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.id This element is included in summaries. 0..1 id Logical id of this artifact
Immunization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Immunization.meta.id 0..1 string Unique id for inter-element referencing
Immunization.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Immunization.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Immunization.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
Immunization.meta.source This element is included in summaries. 0..1 uri Register or system the vaccination was recorded in, where one can be identified
Immunization.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Immunization.meta.security This element is included in summaries. 0..* Coding [DA] Privatmarkering
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Immunization.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Immunization.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Immunization.text 0..1 Narrative 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
Immunization.contained 0..* Resource Contained, inline Resources
Immunization.extension 0..* Extension Additional content defined by implementations
Immunization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Immunization.Slices for identifier 0..* Identifier Business identifier
Slice: Unordered, Open by value:system
Immunization.Slices for identifier.identifier:DdvVaccinationId 0..1 Identifier [DA] DDV vaccinationsid
Immunization.Slices for identifier.identifier:DdvVaccinationId.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for identifier.identifier:DdvVaccinationId.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Immunization.Slices for identifier.identifier:DdvVaccinationId.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Immunization.Slices for identifier.identifier:DdvVaccinationId.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Immunization.Slices for identifier.identifier:DdvVaccinationId.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: http://vaccinationsregister.dk/schemas/2013/12/01/VaccinationIdentifier (no extensions allowed)
Immunization.Slices for identifier.identifier:DdvVaccinationId.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Immunization.Slices for identifier.identifier:DdvVaccinationId.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Immunization.Slices for identifier.identifier:DdvVaccinationId.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code Status of the vaccination - an administered vaccination is completed
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason 0..1 CodeableConcept Reason the vaccination was not administered - not used by this profile as its unsupported by DDV
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
Immunization.vaccineCode This element is included in summaries. 1..1 CodeableConcept Vaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Immunization.vaccineCode.id 0..1 string Unique id for inter-element referencing
Immunization.vaccineCode.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
Immunization.vaccineCode.Slices for coding.coding:ATC This element is included in summaries. 0..1 Coding WHO ATC code for the vaccine, descending from J07
Binding: DK Vaccine ATC Codes (required)
Immunization.vaccineCode.Slices for coding.coding:ATC.id 0..1 string Unique id for inter-element referencing
Immunization.vaccineCode.Slices for coding.coding:ATC.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding.coding:ATC.system This element is included in summaries. 1..1 uri Identity of the terminology system
Fixed Value: http://www.whocc.no/atc (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:ATC.version This element is included in summaries. 0..1 string Version of the system - if relevant
Immunization.vaccineCode.Slices for coding.coding:ATC.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:ATC.display This element is included in summaries. 0..1 string Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:ATC.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode This element is included in summaries. 0..1 Coding SNOMED CT code for the vaccine
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.id 0..1 string Unique id for inter-element referencing
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct (extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.version This element is included in summaries. 0..1 string Version of the system - if relevant
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.display This element is included in summaries. 0..1 string Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine This element is included in summaries. 0..1 Coding [DA] DDV vaccineid
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.id 0..1 string Unique id for inter-element referencing
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.system This element is included in summaries. 1..1 uri Identity of the terminology system
Fixed Value: http://vaccinationsregister.dk/schemas/2013/12/01/VaccineIdentifier (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.version This element is included in summaries. 0..1 string Version of the system - if relevant
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.display This element is included in summaries. 0..1 string Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Immunization.vaccineCode.text This element is included in summaries. 0..1 string Plain text representation of the concept
Immunization.patient This element is included in summaries. 1..1 Reference(Danish Core Patient Profile) Who was immunized
Immunization.encounter 0..1 Reference(Encounter) Encounter immunization was part of
Immunization.occurrence[x] This element is included in summaries. 1..1 Vaccine administration date
Immunization.occurrence[x].occurrenceDateTime dateTime
Immunization.occurrence[x].occurrenceString string
Immunization.recorded 0..1 dateTime When the immunization was first captured in the subject's record
Immunization.primarySource This element is included in summaries. 0..1 boolean Whether the record was captured by the party that administered the vaccination
Immunization.reportOrigin 0..1 CodeableConcept Source of the record when it was not captured by the administering party
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
Immunization.location 0..1 Reference(Location) Where immunization occurred
Immunization.manufacturer 0..1 Reference(Organization) Vaccine manufacturer
Immunization.lotNumber 0..1 string Vaccine lot number. Also known as batch number
Immunization.expirationDate 0..1 date Vaccine expiration date
Immunization.site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
Immunization.route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
Immunization.doseQuantity C 0..1 SimpleQuantity(4.0.1) Amount of vaccine administered
Constraints: sqty-1
Immunization.performer This element is included in summaries. 0..* BackboneElement Who performed event
Immunization.performer.id 0..1 string Unique id for inter-element referencing
Immunization.performer.extension 0..* Extension Additional content defined by implementations
Immunization.performer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.performer.function This element is included in summaries. 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
Immunization.performer.actor This element is included in summaries. 1..1 Reference(Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Organization Profile) Who administered the vaccination - a structured reference is preferred over a free-text display
Immunization.note This element is included in summaries. 0..* Annotation Additional information about the vaccination without a dedicated element
Immunization.reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
Immunization.reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Why immunization occurred
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency
Immunization.subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
Immunization.education C 0..* BackboneElement Educational material presented to patient
Constraints: imm-1
Immunization.education.id 0..1 string Unique id for inter-element referencing
Immunization.education.extension 0..* Extension Additional content defined by implementations
Immunization.education.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.education.documentType 0..1 string Educational material document identifier
Immunization.education.reference 0..1 uri Educational material reference pointer
Immunization.education.publicationDate 0..1 dateTime Educational material publication date
Immunization.education.presentationDate 0..1 dateTime Educational material presentation date
Immunization.programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
Immunization.fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
Immunization.reaction 0..* BackboneElement Details of a reaction that follows immunization
Immunization.reaction.id 0..1 string Unique id for inter-element referencing
Immunization.reaction.extension 0..* Extension Additional content defined by implementations
Immunization.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.reaction.date 0..1 dateTime When reaction started
Immunization.reaction.detail 0..1 Reference(Observation) Additional information on reaction
Immunization.reaction.reported 0..1 boolean Indicates self-reported reaction
Immunization.protocolApplied 0..* BackboneElement Vaccination course or series that the administration is part of
Immunization.protocolApplied.id 0..1 string Unique id for inter-element referencing
Immunization.protocolApplied.extension 0..* Extension Additional content defined by implementations
Immunization.protocolApplied.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.protocolApplied.series 0..1 string Name of vaccine series
Immunization.protocolApplied.authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
Immunization.protocolApplied.targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Immunization.protocolApplied.doseNumber[x] 1..1 Dose number within series
Immunization.protocolApplied.doseNumber[x].doseNumberPositiveInt positiveInt
Immunization.protocolApplied.doseNumber[x].doseNumberString string
Immunization.protocolApplied.seriesDoses[x] 0..1 Recommended number of doses for immunity
Immunization.protocolApplied.seriesDoses[x].seriesDosesPositiveInt positiveInt
Immunization.protocolApplied.seriesDoses[x].seriesDosesString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Immunization.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Immunization.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Immunization.identifier:DdvVaccinationId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Immunization.identifier:DdvVaccinationId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.statusReason Base example Immunization Status Reason Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
Immunization.vaccineCode.​coding:ATC Base required DK Vaccine ATC Codes 📦3.8.0 This IG
Immunization.reportOrigin Base example Immunization Origin Codes 📍4.0.1 FHIR Std.
Immunization.site Base example Codes for Immunization Site of Administration 📍4.0.1 FHIR Std.
Immunization.route Base example Immunization Route Codes 📍4.0.1 FHIR Std.
Immunization.performer.​function Base extensible Immunization Function Codes 📍4.0.1 FHIR Std.
Immunization.reasonCode Base example Immunization Reason Codes 📍4.0.1 FHIR Std.
Immunization.subpotentReason Base example Immunization Subpotent Reason 📍4.0.1 FHIR Std.
Immunization.programEligibility Base example Immunization Program Eligibility 📍4.0.1 FHIR Std.
Immunization.fundingSource Base example Immunization Funding Source 📍4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Immunization

Summary

Mandatory: 0 element(8 nested mandatory elements)
Fixed: 3 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Immunization.identifier
  • The element 1 is sliced based on the value of Immunization.vaccineCode.coding

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Immunization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Immunization.Slices for identifier 0..* Identifier Business identifier
Slice: Unordered, Open by value:system
Immunization.Slices for identifier.identifier:DdvVaccinationId 0..1 Identifier [DA] DDV vaccinationsid
Immunization.Slices for identifier.identifier:DdvVaccinationId.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Immunization.Slices for identifier.identifier:DdvVaccinationId.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: http://vaccinationsregister.dk/schemas/2013/12/01/VaccinationIdentifier (no extensions allowed)
Immunization.Slices for identifier.identifier:DdvVaccinationId.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code Status of the vaccination - an administered vaccination is completed
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason 0..1 CodeableConcept Reason the vaccination was not administered - not used by this profile as its unsupported by DDV
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
Immunization.vaccineCode This element is included in summaries. 1..1 CodeableConcept Vaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Immunization.vaccineCode.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
Immunization.vaccineCode.Slices for coding.coding:ATC This element is included in summaries. 0..1 Coding WHO ATC code for the vaccine, descending from J07
Binding: DK Vaccine ATC Codes (required)
Immunization.vaccineCode.Slices for coding.coding:ATC.system This element is included in summaries. 1..1 uri Identity of the terminology system
Fixed Value: http://www.whocc.no/atc (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:ATC.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode This element is included in summaries. 0..1 Coding SNOMED CT code for the vaccine
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct (extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine This element is included in summaries. 0..1 Coding [DA] DDV vaccineid
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.system This element is included in summaries. 1..1 uri Identity of the terminology system
Fixed Value: http://vaccinationsregister.dk/schemas/2013/12/01/VaccineIdentifier (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Immunization.vaccineCode.text This element is included in summaries. 0..1 string Plain text representation of the concept
Immunization.patient This element is included in summaries. 1..1 Reference(Danish Core Patient Profile) Who was immunized
Immunization.occurrence[x] This element is included in summaries. 1..1 Vaccine administration date
Immunization.occurrence[x].occurrenceDateTime dateTime
Immunization.occurrence[x].occurrenceString string
Immunization.recorded 0..1 dateTime When the immunization was first captured in the subject's record
Immunization.primarySource This element is included in summaries. 0..1 boolean Whether the record was captured by the party that administered the vaccination
Immunization.reportOrigin 0..1 CodeableConcept Source of the record when it was not captured by the administering party
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
Immunization.lotNumber 0..1 string Vaccine lot number. Also known as batch number
Immunization.note This element is included in summaries. 0..* Annotation Additional information about the vaccination without a dedicated element
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency
Immunization.protocolApplied 0..* BackboneElement Vaccination course or series that the administration is part of
Immunization.protocolApplied.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.protocolApplied.targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Immunization.protocolApplied.doseNumber[x] 1..1 Dose number within series
Immunization.protocolApplied.doseNumber[x].doseNumberPositiveInt positiveInt
Immunization.protocolApplied.doseNumber[x].doseNumberString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.identifier:DdvVaccinationId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.statusReason Base example Immunization Status Reason Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
Immunization.vaccineCode.​coding:ATC Base required DK Vaccine ATC Codes 📦3.8.0 This IG
Immunization.reportOrigin Base example Immunization Origin Codes 📍4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.meta
Immunization.meta.versionId 0..1 id Version specific identifier
Immunization.meta.source 0..1 uri Register or system the vaccination was recorded in, where one can be identified
Immunization.meta.security 0..* Coding [DA] Privatmarkering
Immunization.Slices for identifier 0..* Identifier Business identifier
Slice: Unordered, Open by value:system
Immunization.Slices for identifier.identifier:DdvVaccinationId 0..1 Identifier [DA] DDV vaccinationsid
Immunization.Slices for identifier.identifier:DdvVaccinationId.system 1..1 uri The namespace for the identifier value
Fixed Value: http://vaccinationsregister.dk/schemas/2013/12/01/VaccinationIdentifier (no extensions allowed)
Immunization.Slices for identifier.identifier:DdvVaccinationId.value 1..1 string The value that is unique
Immunization.status 1..1 code Status of the vaccination - an administered vaccination is completed
Immunization.statusReason 0..1 CodeableConcept Reason the vaccination was not administered - not used by this profile as its unsupported by DDV
Immunization.vaccineCode 1..1 CodeableConcept Vaccine product administered
Immunization.vaccineCode.Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
Immunization.vaccineCode.Slices for coding.coding:ATC 0..1 Coding WHO ATC code for the vaccine, descending from J07
Binding: DK Vaccine ATC Codes (required)
Immunization.vaccineCode.Slices for coding.coding:ATC.system 1..1 uri Identity of the terminology system
Fixed Value: http://www.whocc.no/atc (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:ATC.code 1..1 code Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode 0..1 Coding SNOMED CT code for the vaccine
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.system 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct (extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.code 1..1 code Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine 0..1 Coding [DA] DDV vaccineid
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.system 1..1 uri Identity of the terminology system
Fixed Value: http://vaccinationsregister.dk/schemas/2013/12/01/VaccineIdentifier (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.code 1..1 code Symbol in syntax defined by the system
Immunization.vaccineCode.text 0..1 string Plain text representation of the concept
Immunization.patient 1..1 Reference(Danish Core Patient Profile) Who was immunized
Immunization.occurrence[x] 1..1 dateTime, string Vaccine administration date
Immunization.recorded 0..1 dateTime When the immunization was first captured in the subject's record
Immunization.primarySource 0..1 boolean Whether the record was captured by the party that administered the vaccination
Immunization.reportOrigin 0..1 CodeableConcept Source of the record when it was not captured by the administering party
Immunization.lotNumber 0..1 string Vaccine lot number. Also known as batch number
Immunization.performer
Immunization.performer.actor 1..1 Reference(Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Organization Profile) Who administered the vaccination - a structured reference is preferred over a free-text display
Immunization.note 0..* Annotation Additional information about the vaccination without a dedicated element
Immunization.protocolApplied 0..* BackboneElement Vaccination course or series that the administration is part of
Immunization.protocolApplied.targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.vaccineCode.​coding:ATC Base required DK Vaccine ATC Codes 📦3.8.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.id This element is included in summaries. 0..1 id Logical id of this artifact
Immunization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Immunization.meta.id 0..1 string Unique id for inter-element referencing
Immunization.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Immunization.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
Immunization.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
Immunization.meta.source This element is included in summaries. 0..1 uri Register or system the vaccination was recorded in, where one can be identified
Immunization.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
Immunization.meta.security This element is included in summaries. 0..* Coding [DA] Privatmarkering
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Immunization.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Immunization.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Immunization.text 0..1 Narrative 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
Immunization.contained 0..* Resource Contained, inline Resources
Immunization.extension 0..* Extension Additional content defined by implementations
Immunization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Immunization.Slices for identifier 0..* Identifier Business identifier
Slice: Unordered, Open by value:system
Immunization.Slices for identifier.identifier:DdvVaccinationId 0..1 Identifier [DA] DDV vaccinationsid
Immunization.Slices for identifier.identifier:DdvVaccinationId.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for identifier.identifier:DdvVaccinationId.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Immunization.Slices for identifier.identifier:DdvVaccinationId.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Immunization.Slices for identifier.identifier:DdvVaccinationId.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Immunization.Slices for identifier.identifier:DdvVaccinationId.system This element is included in summaries. 1..1 uri The namespace for the identifier value
Fixed Value: http://vaccinationsregister.dk/schemas/2013/12/01/VaccinationIdentifier (no extensions allowed)
Immunization.Slices for identifier.identifier:DdvVaccinationId.value This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Immunization.Slices for identifier.identifier:DdvVaccinationId.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Immunization.Slices for identifier.identifier:DdvVaccinationId.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code Status of the vaccination - an administered vaccination is completed
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason 0..1 CodeableConcept Reason the vaccination was not administered - not used by this profile as its unsupported by DDV
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
Immunization.vaccineCode This element is included in summaries. 1..1 CodeableConcept Vaccine product administered
Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
Immunization.vaccineCode.id 0..1 string Unique id for inter-element referencing
Immunization.vaccineCode.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
Immunization.vaccineCode.Slices for coding.coding:ATC This element is included in summaries. 0..1 Coding WHO ATC code for the vaccine, descending from J07
Binding: DK Vaccine ATC Codes (required)
Immunization.vaccineCode.Slices for coding.coding:ATC.id 0..1 string Unique id for inter-element referencing
Immunization.vaccineCode.Slices for coding.coding:ATC.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding.coding:ATC.system This element is included in summaries. 1..1 uri Identity of the terminology system
Fixed Value: http://www.whocc.no/atc (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:ATC.version This element is included in summaries. 0..1 string Version of the system - if relevant
Immunization.vaccineCode.Slices for coding.coding:ATC.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:ATC.display This element is included in summaries. 0..1 string Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:ATC.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode This element is included in summaries. 0..1 Coding SNOMED CT code for the vaccine
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.id 0..1 string Unique id for inter-element referencing
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.system This element is included in summaries. 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct (extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.version This element is included in summaries. 0..1 string Version of the system - if relevant
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.display This element is included in summaries. 0..1 string Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:SCTVaccineCode.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine This element is included in summaries. 0..1 Coding [DA] DDV vaccineid
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.id 0..1 string Unique id for inter-element referencing
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.system This element is included in summaries. 1..1 uri Identity of the terminology system
Fixed Value: http://vaccinationsregister.dk/schemas/2013/12/01/VaccineIdentifier (no extensions allowed)
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.version This element is included in summaries. 0..1 string Version of the system - if relevant
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.code This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.display This element is included in summaries. 0..1 string Representation defined by the system
Immunization.vaccineCode.Slices for coding.coding:DdvVaccine.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Immunization.vaccineCode.text This element is included in summaries. 0..1 string Plain text representation of the concept
Immunization.patient This element is included in summaries. 1..1 Reference(Danish Core Patient Profile) Who was immunized
Immunization.encounter 0..1 Reference(Encounter) Encounter immunization was part of
Immunization.occurrence[x] This element is included in summaries. 1..1 Vaccine administration date
Immunization.occurrence[x].occurrenceDateTime dateTime
Immunization.occurrence[x].occurrenceString string
Immunization.recorded 0..1 dateTime When the immunization was first captured in the subject's record
Immunization.primarySource This element is included in summaries. 0..1 boolean Whether the record was captured by the party that administered the vaccination
Immunization.reportOrigin 0..1 CodeableConcept Source of the record when it was not captured by the administering party
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
Immunization.location 0..1 Reference(Location) Where immunization occurred
Immunization.manufacturer 0..1 Reference(Organization) Vaccine manufacturer
Immunization.lotNumber 0..1 string Vaccine lot number. Also known as batch number
Immunization.expirationDate 0..1 date Vaccine expiration date
Immunization.site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
Immunization.route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
Immunization.doseQuantity C 0..1 SimpleQuantity(4.0.1) Amount of vaccine administered
Constraints: sqty-1
Immunization.performer This element is included in summaries. 0..* BackboneElement Who performed event
Immunization.performer.id 0..1 string Unique id for inter-element referencing
Immunization.performer.extension 0..* Extension Additional content defined by implementations
Immunization.performer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.performer.function This element is included in summaries. 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
Immunization.performer.actor This element is included in summaries. 1..1 Reference(Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Organization Profile) Who administered the vaccination - a structured reference is preferred over a free-text display
Immunization.note This element is included in summaries. 0..* Annotation Additional information about the vaccination without a dedicated element
Immunization.reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
Immunization.reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Why immunization occurred
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency
Immunization.subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
Immunization.education C 0..* BackboneElement Educational material presented to patient
Constraints: imm-1
Immunization.education.id 0..1 string Unique id for inter-element referencing
Immunization.education.extension 0..* Extension Additional content defined by implementations
Immunization.education.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.education.documentType 0..1 string Educational material document identifier
Immunization.education.reference 0..1 uri Educational material reference pointer
Immunization.education.publicationDate 0..1 dateTime Educational material publication date
Immunization.education.presentationDate 0..1 dateTime Educational material presentation date
Immunization.programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
Immunization.fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
Immunization.reaction 0..* BackboneElement Details of a reaction that follows immunization
Immunization.reaction.id 0..1 string Unique id for inter-element referencing
Immunization.reaction.extension 0..* Extension Additional content defined by implementations
Immunization.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.reaction.date 0..1 dateTime When reaction started
Immunization.reaction.detail 0..1 Reference(Observation) Additional information on reaction
Immunization.reaction.reported 0..1 boolean Indicates self-reported reaction
Immunization.protocolApplied 0..* BackboneElement Vaccination course or series that the administration is part of
Immunization.protocolApplied.id 0..1 string Unique id for inter-element referencing
Immunization.protocolApplied.extension 0..* Extension Additional content defined by implementations
Immunization.protocolApplied.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.protocolApplied.series 0..1 string Name of vaccine series
Immunization.protocolApplied.authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
Immunization.protocolApplied.targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Immunization.protocolApplied.doseNumber[x] 1..1 Dose number within series
Immunization.protocolApplied.doseNumber[x].doseNumberPositiveInt positiveInt
Immunization.protocolApplied.doseNumber[x].doseNumberString string
Immunization.protocolApplied.seriesDoses[x] 0..1 Recommended number of doses for immunity
Immunization.protocolApplied.seriesDoses[x].seriesDosesPositiveInt positiveInt
Immunization.protocolApplied.seriesDoses[x].seriesDosesString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Immunization.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Immunization.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Immunization.identifier:DdvVaccinationId.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Immunization.identifier:DdvVaccinationId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.statusReason Base example Immunization Status Reason Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
Immunization.vaccineCode.​coding:ATC Base required DK Vaccine ATC Codes 📦3.8.0 This IG
Immunization.reportOrigin Base example Immunization Origin Codes 📍4.0.1 FHIR Std.
Immunization.site Base example Codes for Immunization Site of Administration 📍4.0.1 FHIR Std.
Immunization.route Base example Immunization Route Codes 📍4.0.1 FHIR Std.
Immunization.performer.​function Base extensible Immunization Function Codes 📍4.0.1 FHIR Std.
Immunization.reasonCode Base example Immunization Reason Codes 📍4.0.1 FHIR Std.
Immunization.subpotentReason Base example Immunization Subpotent Reason 📍4.0.1 FHIR Std.
Immunization.programEligibility Base example Immunization Program Eligibility 📍4.0.1 FHIR Std.
Immunization.fundingSource Base example Immunization Funding Source 📍4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Immunization

Summary

Mandatory: 0 element(8 nested mandatory elements)
Fixed: 3 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Immunization.identifier
  • The element 1 is sliced based on the value of Immunization.vaccineCode.coding

 

Other representations of profile: CSV, Excel, Schematron