EHDSImmunisationObligations
type: StructureDefinition
node role: treeRoot
id:
  v: EHDSImmunisationObligations
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition EHDSImmunisationObligations Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> EHDSImmunisation 0..* EHDSImmunisation Immunisation model #xD; header #xD; subject O 1..1 EHDSPatient Patient/subject information Obligations Actor SHALL:able-to-populate Producer #xD; identifier O 0..* Identifier Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries). Obligations Actor SHOULD:able-to-populate Producer #xD; status O 1..1 CodeableConcept Status of the immunisation event (completed, not-done). Obligations Actor SHALL:able-to-populate Producer #xD; vaccine O 1..1 CodeableConcept Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product. Obligations Actor SHALL:able-to-populate Producer #xD; administeredProduct O 0..1 EHDSMedication Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary. Obligations Actor SHOULD:able-to-populate Producer #xD; identifyingCode[x] O 0..* CodeableConcept, Identifier An identifier (e.g. from EMA SPOR PMS or national registry) or a code (e.g. from SNOMED CT or national code system) for the product (virtual product, branded product, or package). If several identifiers are specified, they shall not have conflicting meanings or very different granularities. An identifier might not exist e.g. for substance-based prescriptions. Obligations Actor SHOULD:able-to-populate Producer #xD; productName O 0..1 string Current trade name (authorised name) of the product. When medication is specified by a CodeableConcept, the name may be omitted when available as the display name of the concept. Obligations Actor SHOULD:able-to-populate Producer #xD; batch O 0..1 Base Batch information of a medicinal product. Typically recorded during dispense or administra…
url:
  v: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationObligations
  l: EHDSImmunisationObligations
version:
  v: 0.4.0
name:
  v: EHDSImmunisationObligations
title:
  v: Immunisation obligations
status:
  v: draft
date:
  v: 2026-02-26T13:12:06+00:00
publisher:
  v: Xt-EHR
contact:
  name:
    v: Xt-EHR
  telecom:
    system:
      v: url
    value:
      v: http://www.xt-ehr.eu/
description:
  v: Obligations for the logical model for immunisation.
fhir version:
  v: 5.0.0
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
kind:
  v: logical
abstract:
  v: false
type:
  v: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisation
  l: EHDSImmunisation
base definition:
  v: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisation
  l: EHDSImmunisation
derivation:
  v: constraint
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 0.4.0
  element:
    id:
      v: EHDSImmunisation
    path:
      v: EHDSImmunisation
    short:
      v: Immunisation model
    definition:
      v: Model describes the administration of immunisation products, including vaccines and immunoglobulins, covering active and passive immunisations. It focuses on immunisation as a clinical procedure rather than the resulting immunity. The model supports routine immunisations at standard doses and may overlap with medication summaries or prescription lists. Natural immunity, immunisation outcomes, refusals, and administration or planning details are out of scope.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Base
      min:
        v: 0
      max:
        v: *
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: EHDSImmunisation.header
    path:
      v: EHDSImmunisation.header
    short:
      v: Basic metadata for this information
    definition:
      v: Basic metadata for this information
    min:
      v: 1
    max:
      v: 1
    base:
      path:
        v: EHDSDataSet.header
      min:
        v: 1
      max:
        v: 1
    type:
      code:
        v: Base
        l: Base
  element:
    id:
      v: EHDSImmunisation.header.subject
    extension:
      extension:
        value: Code
      extension:
        value: Canonical
      extension:
        value: Canonical
      url:
        v: http://hl7.org/fhir/StructureDefinition/obligation
        l: obligation
    path:
      v: EHDSImmunisation.header.subject
    short:
      v: Patient/subject information
    definition:
      v: Patient/subject information
    min:
      v: 1
    max:
      v: 1
    base:
      path:
        v: EHDSDataSet.header.subject
      min:
        v: 1
      max:
        v: 1
    type:
      code:
        v: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSPatient
        l: EHDSPatient
  element:
    id:
      v: EHDSImmunisation.header.identifier
    extension:
      extension:
        value: Code
      extension:
        value: Canonical
      extension:
        value: Canonical
      url:
        v: http://hl7.org/fhir/StructureDefinition/obligation
        l: obligation
    path:
      v: EHDSImmunisation.header.identifier
    short:
      v: Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).
    definition:
      v: Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: EHDSDataSet.header.identifier
      min:
        v: 0
      max:
        v: *
    type:
      code:
        v: Identifier
        l: Identifier
  element:
    id:
      v: EHDSImmunisation.header.author[x]
    path:
      v: EHDSImmunisation.header.author[x]
    short:
      v: The author of the immunisation statement.
    definition:
      v: The author of the immunisation statement.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: EHDSDataSet.header.author[x]
      min:
        v: 0
      max:
        v: *

v: code
l: code

Code
v: SHALL:able-to-populate

v: actor
l: actor

v: code
l: code

Code
v: SHOULD:able-to-populate

v: actor
l: actor

id:
  v: EHDSImmunisation.header.date
path:
  v: EHDSImmunisation.header.date
short:
  v: Date and optionally time of authoring/issuing
definition:
  v: Date and optionally time of authoring/issuing
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSDataSet.header.date
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime

id:
  v: EHDSImmunisation.header.status
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:able-to-populate
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: https://www.xt-ehr.eu/specifications/fhir/actor-producer
      l: actor-producer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationObligations|0.4.0
      l: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationObligations
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
path:
  v: EHDSImmunisation.header.status
short:
  v: Status of the immunisation event (completed, not-done).
definition:
  v: Status of the immunisation event (completed, not-done).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: EHDSDataSet.header.status
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept

id:
  v: EHDSImmunisation.header.source
path:
  v: EHDSImmunisation.header.source
short:
  v: Source of information (e.g. patient, patient's proxy). Used in case the patient has authored the information or the author has submitted patient-stated information.
definition:
  v: Source of information (e.g. patient, patient's proxy). Used in case the patient has authored the information or the author has submitted patient-stated information.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSDataSet.header.source
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept

id:
  v: EHDSImmunisation.header.language
path:
  v: EHDSImmunisation.header.language
short:
  v: Language in which the resource is written. Language is expressed by the IETF language tag.
definition:
  v: Language in which the resource is written. Language is expressed by the IETF language tag.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSDataSet.header.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  strength:
    v: preferred
  description:
    v: BCP 47

id:
  v: EHDSImmunisation.diseaseOrAgentTargeted
path:
  v: EHDSImmunisation.diseaseOrAgentTargeted
short:
  v: Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).
definition:
  v: Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).
min:
  v: 0
max:
  v: *
base:
  path:
    v: EHDSImmunisation.diseaseOrAgentTargeted
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  strength:
    v: preferred
  description:
    v: ICD-10, SNOMED CT

id:
  v: EHDSImmunisation.vaccine
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:able-to-populate
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: https://www.xt-ehr.eu/specifications/fhir/actor-producer
      l: actor-producer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationObligations|0.4.0
      l: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationObligations
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
path:
  v: EHDSImmunisation.vaccine
short:
  v: Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.
definition:
  v: Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: EHDSImmunisation.vaccine
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  strength:
    v: preferred
  description:
    v: SNOMED CT, ATC

id:
  v: EHDSImmunisation.administeredProduct
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHOULD:able-to-populate
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: https://www.xt-ehr.eu/specifications/fhir/actor-producer
      l: actor-producer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationObligations|0.4.0
      l: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationObligations
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
path:
  v: EHDSImmunisation.administeredProduct
short:
  v: Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.
definition:
  v: Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSImmunisation.administeredProduct
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSMedication
    l: EHDSMedication

id:
  v: EHDSImmunisation.administeredProduct.identifyingCode[x]
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHOULD:able-to-populate
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: https://www.xt-ehr.eu/specifications/fhir/actor-producer
      l: actor-producer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationObligations|0.4.0
      l: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationObligations
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
path:
  v: EHDSImmunisation.administeredProduct.identifyingCode[x]
short:
  v: An identifier (e.g. from EMA SPOR PMS or national registry) or a code (e.g. from SNOMED CT or national code system) for the product (virtual product, branded product, or package). If several identifiers are specified, they shall not have conflicting meanings or very different granularities. An identifier might not exist e.g. for substance-based prescriptions.
definition:
  v: An identifier (e.g. from EMA SPOR PMS or national registry) or a code (e.g. from SNOMED CT or national code system) for the product (virtual product, branded product, or package). If several identifiers are specified, they shall not have conflicting meanings or very different granularities. An identifier might not exist e.g. for substance-based prescriptions.
min:
  v: 0
max:
  v: *
base:
  path:
    v: EHDSMedication.identifyingCode[x]
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
type:
  code:
    v: Identifier
    l: Identifier

id:
  v: EHDSImmunisation.administeredProduct.classification
path:
  v: EHDSImmunisation.administeredProduct.classification
short:
  v: Classification (e.g. ATC; narcotic/psychotropic; orphan drug; etc.)
definition:
  v: Classification (e.g. ATC; narcotic/psychotropic; orphan drug; etc.)
min:
  v: 0
max:
  v: *
base:
  path:
    v: EHDSMedication.classification
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  strength:
    v: preferred
  description:
    v: WHO ATC

id:
  v: EHDSImmunisation.administeredProduct.productName
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHOULD:able-to-populate
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: https://www.xt-ehr.eu/specifications/fhir/actor-producer
      l: actor-producer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationObligations|0.4.0
      l: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationObligations
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
path:
  v: EHDSImmunisation.administeredProduct.productName
short:
  v: Current trade name (authorised name) of the product. When medication is specified by a CodeableConcept, the name may be omitted when available as the display name of the concept.
definition:
  v: Current trade name (authorised name) of the product. When medication is specified by a CodeableConcept, the name may be omitted when available as the display name of the concept.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSMedication.productName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: EHDSImmunisation.administeredProduct.marketingAuthorisationHolder
path:
  v: EHDSImmunisation.administeredProduct.marketingAuthorisationHolder
short:
  v: Marketing authorisation holder of the medicinal product. Relevant for identifying the exact product. If the product does not have a marketing authorisation, the manufacturer information may be used.
definition:
  v: Marketing authorisation holder of the medicinal product. Relevant for identifying the exact product. If the product does not have a marketing authorisation, the manufacturer information may be used.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSMedication.marketingAuthorisationHolder
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Base
    l: Base

id:
  v: EHDSImmunisation.administeredProduct.marketingAuthorisationHolder.organisationName
path:
  v: EHDSImmunisation.administeredProduct.marketingAuthorisationHolder.organisationName
short:
  v: Name of the organisation holding the authorisation for marketing/manufacturing
definition:
  v: Name of the organisation holding the authorisation for marketing/manufacturing
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSMedication.marketingAuthorisationHolder.organisationName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: EHDSImmunisation.administeredProduct.marketingAuthorisationHolder.organisationIdentifier
path:
  v: EHDSImmunisation.administeredProduct.marketingAuthorisationHolder.organisationIdentifier
short:
  v: Identifier of the organisation and/or its physical location
definition:
  v: Identifier of the organisation and/or its physical location
min:
  v: 0
max:
  v: *
base:
  path:
    v: EHDSMedication.marketingAuthorisationHolder.organisationIdentifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Identifier
    l: Identifier

id:
  v: EHDSImmunisation.administeredProduct.doseForm
path:
  v: EHDSImmunisation.administeredProduct.doseForm
short:
  v: Dose form at the package level (e.g. authorised dose form), corresponding to IDMP Combined Pharmaceutical Dose Form (this includes terms from EDQM Combination Pack or Combined Dose Form lists). Dose form for a single package item is defined in item.doseForm.
definition:
  v: Dose form at the package level (e.g. authorised dose form), corresponding to IDMP Combined Pharmaceutical Dose Form (this includes terms from EDQM Combination Pack or Combined Dose Form lists). Dose form for a single package item is defined in item.doseForm.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSMedication.doseForm
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  strength:
    v: preferred
  description:
    v: EDQM Standard Terms

id:
  v: EHDSImmunisation.administeredProduct.description
path:
  v: EHDSImmunisation.administeredProduct.description
short:
  v: Textual description of the product, e.g. including package description.
definition:
  v: Textual description of the product, e.g. including package description.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSMedication.description
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: EHDSImmunisation.administeredProduct.item
path:
  v: EHDSImmunisation.administeredProduct.item
short:
  v: A medication item. For combination packs, this can be multiple manufactured items with each item having its own dose form and ingredients+strengths defined
definition:
  v: A medication item. For combination packs, this can be multiple manufactured items with each item having its own dose form and ingredients+strengths defined
min:
  v: 0
max:
  v: *
base:
  path:
    v: EHDSMedication.item
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Base
    l: Base

id:
  v: EHDSImmunisation.administeredProduct.item.doseForm
path:
  v: EHDSImmunisation.administeredProduct.item.doseForm
short:
  v: Administrable or manufactured item dose form, depending on the type of medication definition. This should not include combined dose forms.
definition:
  v: Administrable or manufactured item dose form, depending on the type of medication definition. This should not include combined dose forms.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSMedication.item.doseForm
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  strength:
    v: preferred
  description:
    v: EDQM Standard Terms

id:
  v: EHDSImmunisation.administeredProduct.item.ingredient
path:
  v: EHDSImmunisation.administeredProduct.item.ingredient
short:
  v: Ingredients
definition:
  v: Ingredients
min:
  v: 1
max:
  v: *
base:
  path:
    v: EHDSMedication.item.ingredient
  min:
    v: 1
  max:
    v: *
type:
  code:
    v: Base
    l: Base

id:
  v: EHDSImmunisation.administeredProduct.item.ingredient.isActive
path:
  v: EHDSImmunisation.administeredProduct.item.ingredient.isActive
short:
  v: Marks whether the ingredient is considered an active ingredient. Excipients are typically not needed, and by default only active ingredients are expected.
definition:
  v: Marks whether the ingredient is considered an active ingredient. Excipients are typically not needed, and by default only active ingredients are expected.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSMedication.item.ingredient.isActive
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean

id:
  v: EHDSImmunisation.administeredProduct.item.ingredient.substance
path:
  v: EHDSImmunisation.administeredProduct.item.ingredient.substance
short:
  v: Substance
definition:
  v: Substance
min:
  v: 1
max:
  v: 1
base:
  path:
    v: EHDSMedication.item.ingredient.substance
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  strength:
    v: preferred
  description:
    v: EMA SPOR SMS

id:
  v: EHDSImmunisation.administeredProduct.item.ingredient.strengthInfo
path:
  v: EHDSImmunisation.administeredProduct.item.ingredient.strengthInfo
short:
  v: Strength of the product - amount of substance per unit
definition:
  v: Strength of the product - amount of substance per unit
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSMedication.item.ingredient.strengthInfo
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Base
    l: Base

id:
  v: EHDSImmunisation.administeredProduct.item.ingredient.strengthInfo.strength
path:
  v: EHDSImmunisation.administeredProduct.item.ingredient.strengthInfo.strength
short:
  v: Concentration or presentation strength, e.g '100 mg/1 ml' or '500 mg per 1 tablet'
definition:
  v: Concentration or presentation strength, e.g '100 mg/1 ml' or '500 mg per 1 tablet'
min:
  v: 1
max:
  v: 1
base:
  path:
    v: EHDSMedication.item.ingredient.strengthInfo.strength
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Ratio
    l: Ratio

id:
  v: EHDSImmunisation.administeredProduct.item.ingredient.strengthInfo.basisOfStrengthSubstance
path:
  v: EHDSImmunisation.administeredProduct.item.ingredient.strengthInfo.basisOfStrengthSubstance
short:
  v: Substance that the strength refers to, especially when different from .item.strength.substance
definition:
  v: Substance that the strength refers to, especially when different from .item.strength.substance
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSMedication.item.ingredient.strengthInfo.basisOfStrengthSubstance
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  strength:
    v: preferred
  description:
    v: EMA SPOR SMS

id:
  v: EHDSImmunisation.administeredProduct.item.unitOfPresentation
path:
  v: EHDSImmunisation.administeredProduct.item.unitOfPresentation
short:
  v: Unit of presentation for the manufactured item (tablet, vial, tube). Typically, the smallest countable object in the package.
definition:
  v: Unit of presentation for the manufactured item (tablet, vial, tube). Typically, the smallest countable object in the package.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSMedication.item.unitOfPresentation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  strength:
    v: preferred
  description:
    v: EDQM Standard Terms

id:
  v: EHDSImmunisation.administeredProduct.item.containedQuantity
path:
  v: EHDSImmunisation.administeredProduct.item.containedQuantity
short:
  v: Manufactured item quantity per one item (3 ml / 1 vial)
definition:
  v: Manufactured item quantity per one item (3 ml / 1 vial)
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSMedication.item.containedQuantity
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Ratio
    l: Ratio

id:
  v: EHDSImmunisation.administeredProduct.item.amount
path:
  v: EHDSImmunisation.administeredProduct.item.amount
short:
  v: Number of such items in this product (5 vials). The combined amount of all items will be considered to be the total package size.
definition:
  v: Number of such items in this product (5 vials). The combined amount of all items will be considered to be the total package size.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSMedication.item.amount
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Quantity
    l: Quantity
binding:
  strength:
    v: preferred
  description:
    v: UCUM for units of measure. EDQM Standard Terms for units of presentation.

id:
  v: EHDSImmunisation.administeredProduct.item.packageType
path:
  v: EHDSImmunisation.administeredProduct.item.packageType
short:
  v: Type of package of the medication item
definition:
  v: Type of package of the medication item
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSMedication.item.packageType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  strength:
    v: preferred
  description:
    v: EDQM Standard Terms for packaging.

id:
  v: EHDSImmunisation.administeredProduct.device
path:
  v: EHDSImmunisation.administeredProduct.device
short:
  v: Administration device included in the product. Devices that are not inside the medication package are excluded.
definition:
  v: Administration device included in the product. Devices that are not inside the medication package are excluded.
min:
  v: 0
max:
  v: *
base:
  path:
    v: EHDSMedication.device
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Base
    l: Base

id:
  v: EHDSImmunisation.administeredProduct.device.deviceQuantity
path:
  v: EHDSImmunisation.administeredProduct.device.deviceQuantity
short:
  v: Number of such devices
definition:
  v: Number of such devices
min:
  v: 1
max:
  v: 1
base:
  path:
    v: EHDSMedication.device.deviceQuantity
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Quantity
    l: Quantity

id:
  v: EHDSImmunisation.administeredProduct.device.device[x]
path:
  v: EHDSImmunisation.administeredProduct.device.device[x]
short:
  v: Device coded
definition:
  v: Device coded
min:
  v: 1
max:
  v: 1
base:
  path:
    v: EHDSMedication.device.device[x]
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
type:
  code:
    v: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDevice
    l: EHDSDevice

id:
  v: EHDSImmunisation.administeredProduct.characteristic
path:
  v: EHDSImmunisation.administeredProduct.characteristic
short:
  v: Additional features of the product (e.g. reimbursable, sugar-free, easy-open cap, score-lined). It is expected that implementers will define a valueset supporting their use cases.
definition:
  v: Additional features of the product (e.g. reimbursable, sugar-free, easy-open cap, score-lined). It is expected that implementers will define a valueset supporting their use cases.
min:
  v: 0
max:
  v: *
base:
  path:
    v: EHDSMedication.characteristic
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Base
    l: Base

id:
  v: EHDSImmunisation.administeredProduct.characteristic.type
path:
  v: EHDSImmunisation.administeredProduct.characteristic.type
short:
  v: A code expressing the type of characteristic.
definition:
  v: A code expressing the type of characteristic.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: EHDSMedication.characteristic.type
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept

id:
  v: EHDSImmunisation.administeredProduct.characteristic.value[x]
path:
  v: EHDSImmunisation.administeredProduct.characteristic.value[x]
short:
  v: Description of the characteristic value.
definition:
  v: Description of the characteristic value.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSMedication.characteristic.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
    l: boolean
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
type:
  code:
    v: string
    l: string
type:
  code:
    v: Quantity
    l: Quantity
type:
  code:
    v: dateTime
    l: dateTime
type:
  code:
    v: integer
    l: integer
type:
  code:
    v: decimal
    l: decimal
type:
  code:
    v: Ratio
    l: Ratio

id:
  v: EHDSImmunisation.administeredProduct.batch
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHOULD:able-to-populate
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: https://www.xt-ehr.eu/specifications/fhir/actor-producer
      l: actor-producer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationObligations|0.4.0
      l: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationObligations
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
path:
  v: EHDSImmunisation.administeredProduct.batch
short:
  v: Batch information of a medicinal product. Typically recorded during dispense or administration, rarely known or relevant for a prescription/request.
definition:
  v: Batch information of a medicinal product. Typically recorded during dispense or administration, rarely known or relevant for a prescription/request.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSMedication.batch
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Base
    l: Base

id:
  v: EHDSImmunisation.administeredProduct.batch.lotNumber
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHOULD:able-to-populate
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: https://www.xt-ehr.eu/specifications/fhir/actor-producer
      l: actor-producer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationObligations|0.4.0
      l: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationObligations
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
path:
  v: EHDSImmunisation.administeredProduct.batch.lotNumber
short:
  v: Batch identifier of the medicinal product.
definition:
  v: Batch identifier of the medicinal product.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSMedication.batch.lotNumber
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: EHDSImmunisation.administeredProduct.batch.expirationDate
path:
  v: EHDSImmunisation.administeredProduct.batch.expirationDate
short:
  v: Batch expiration date of the medicinal product.
definition:
  v: Batch expiration date of the medicinal product.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSMedication.batch.expirationDate
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime

id:
  v: EHDSImmunisation.administrationTime
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:able-to-populate
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: https://www.xt-ehr.eu/specifications/fhir/actor-producer
      l: actor-producer
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-source
      l: snapshot-source
    value: Canonical
      v: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationObligations|0.4.0
      l: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationObligations
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
path:
  v: EHDSImmunisation.administrationTime
short:
  v: The date and optionally the exact time when the vaccination was administered.
definition:
  v: The date and optionally the exact time when the vaccination was administered.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: EHDSImmunisation.administrationTime
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime

id:
  v: EHDSImmunisation.administeringCentre
path:
  v: EHDSImmunisation.administeringCentre
short:
  v: Administering centre or a health authority responsible for the vaccination event
definition:
  v: Administering centre or a health authority responsible for the vaccination event
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSImmunisation.administeringCentre
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation
    l: EHDSOrganisation

id:
  v: EHDSImmunisation.administrator
path:
  v: EHDSImmunisation.administrator
short:
  v: Health professional responsible for administering the immunisation product.
definition:
  v: Health professional responsible for administering the immunisation product.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSImmunisation.administrator
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional
    l: EHDSHealthProfessional

id:
  v: EHDSImmunisation.note
path:
  v: EHDSImmunisation.note
short:
  v: Any additional free-text information about the immunisation
definition:
  v: Any additional free-text information about the immunisation
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EHDSImmunisation.note
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string

element:
  id:
    v: EHDSImmunisation
  path:
    v: EHDSImmunisation
element:
  id:
    v: EHDSImmunisation.header.subject
  extension:
    extension:
      url:
        v: code
        l: code
      value: Code
        v: SHALL:able-to-populate
    extension:
      url:
        v: actor
        l: actor
      value: Canonical
        v: https://www.xt-ehr.eu/specifications/fhir/actor-producer
        l: actor-producer
    url:
      v: http://hl7.org/fhir/StructureDefinition/obligation
      l: obligation
  path:
    v: EHDSImmunisation.header.subject
element:
  id:
    v: EHDSImmunisation.header.identifier
  extension:
    extension:
      url:
        v: code
        l: code
      value: Code
        v: SHOULD:able-to-populate
    extension:
      url:
        v: actor
        l: actor
      value: Canonical
        v: https://www.xt-ehr.eu/specifications/fhir/actor-producer
        l: actor-producer
    url:
      v: http://hl7.org/fhir/StructureDefinition/obligation
      l: obligation
  path:
    v: EHDSImmunisation.header.identifier
element:
  id:
    v: EHDSImmunisation.header.status
  extension:
    extension:
      url:
        v: code
        l: code
      value: Code
        v: SHALL:able-to-populate
    extension:
      url:
        v: actor
        l: actor
      value: Canonical
        v: https://www.xt-ehr.eu/specifications/fhir/actor-producer
        l: actor-producer
    url:
      v: http://hl7.org/fhir/StructureDefinition/obligation
      l: obligation
  path:
    v: EHDSImmunisation.header.status
element:
  id:
    v: EHDSImmunisation.vaccine
  extension:
    extension:
      url:
        v: code
        l: code
      value: Code
        v: SHALL:able-to-populate
    extension:
      url:
        v: actor
        l: actor
      value: Canonical
        v: https://www.xt-ehr.eu/specifications/fhir/actor-producer
        l: actor-producer
    url:
      v: http://hl7.org/fhir/StructureDefinition/obligation
      l: obligation
  path:
    v: EHDSImmunisation.vaccine
element:
  id:
    v: EHDSImmunisation.administeredProduct
  extension:
    extension:
      url:
        v: code
        l: code
      value: Code
        v: SHOULD:able-to-populate
    extension:
      url:
        v: actor
        l: actor
      value: Canonical
        v: https://www.xt-ehr.eu/specifications/fhir/actor-producer
        l: actor-producer
    url:
      v: http://hl7.org/fhir/StructureDefinition/obligation
      l: obligation
  path:
    v: EHDSImmunisation.administeredProduct
element:
  id:
    v: EHDSImmunisation.administeredProduct.identifyingCode[x]
  extension:
    extension:
      url:
        v: code
        l: code
      value: Code
        v: SHOULD:able-to-populate
    extension:
      url:
        v: actor
        l: actor
      value: Canonical
        v: https://www.xt-ehr.eu/specifications/fhir/actor-producer
        l: actor-producer
    url:
      v: http://hl7.org/fhir/StructureDefinition/obligation
      l: obligation
  path:
    v: EHDSImmunisation.administeredProduct.identifyingCode[x]
element:
  id:
    v: EHDSImmunisation.administeredProduct.productName
  extension:
    extension:
      url:
        v: code
        l: code
      value: Code
        v: SHOULD:able-to-populate
    extension:
      url:
        v: actor
        l: actor
      value: Canonical
        v: https://www.xt-ehr.eu/specifications/fhir/actor-producer
        l: actor-producer
    url:
      v: http://hl7.org/fhir/StructureDefinition/obligation
      l: obligation
  path:
    v: EHDSImmunisation.administeredProduct.productName
element:
  id:
    v: EHDSImmunisation.administeredProduct.batch
  extension:
    extension:
      url:
        v: code
        l: code
      value: Code
        v: SHOULD:able-to-populate
    extension:
      url:
        v: actor
        l: actor
      value: Canonical
        v: https://www.xt-ehr.eu/specifications/fhir/actor-producer
        l: actor-producer
    url:
      v: http://hl7.org/fhir/StructureDefinition/obligation
      l: obligation
  path:
    v: EHDSImmunisation.administeredProduct.batch
element:
  id:
    v: EHDSImmunisation.administeredProduct.batch.lotNumber
  extension:
    extension:
      url:
        v: code
        l: code
      value: Code
        v: SHOULD:able-to-populate
    extension:
      url:
        v: actor
        l: actor
      value: Canonical
        v: https://www.xt-ehr.eu/specifications/fhir/actor-producer
        l: actor-producer
    url:
      v: http://hl7.org/fhir/StructureDefinition/obligation
      l: obligation

v: EHDSImmunisation.administeredProduct.batch.lotNumber

id:
  v: EHDSImmunisation.administrationTime
extension:
  extension:
    url:
      v: code
      l: code
    value: Code
      v: SHALL:able-to-populate
  extension:
    url:
      v: actor
      l: actor
    value: Canonical
      v: https://www.xt-ehr.eu/specifications/fhir/actor-producer
      l: actor-producer
  url:
    v: http://hl7.org/fhir/StructureDefinition/obligation
    l: obligation
path:
  v: EHDSImmunisation.administrationTime