{
  "description": "Obligations for the logical model of immunisation in the scope of laboratory use case",
  "_filename": "StructureDefinition-EHDSImmunisationLaboratoryObligations.json",
  "package_name": "xtehr.eu.ehds.models",
  "date": "2026-04-13T14:09:30+02:00",
  "derivation": "constraint",
  "publisher": "Xt-EHR",
  "fhirVersion": "5.0.0",
  "name": "EHDSImmunisationLaboratoryObligations",
  "mapping": [ {
    "uri": "http://hl7.org/v3",
    "name": "RIM Mapping",
    "identity": "rim"
  } ],
  "abstract": false,
  "type": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisation",
  "experimental": null,
  "resourceType": "StructureDefinition",
  "title": "Immunisation laboratory specific obligations",
  "package_version": "1.0.0",
  "snapshot": {
    "element": [ {
      "path": "EHDSImmunisation",
      "min": 0,
      "definition": "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.",
      "isModifier": false,
      "short": "Immunisation model",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "max": "*",
      "id": "EHDSImmunisation",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Base"
      }
    }, {
      "id": "EHDSImmunisation.header",
      "max": "1",
      "min": 1,
      "base": {
        "max": "1",
        "min": 1,
        "path": "EHDSDataSet.header"
      },
      "path": "EHDSImmunisation.header",
      "type": [ {
        "code": "Base"
      } ],
      "short": "Basic metadata for this information",
      "definition": "Basic metadata for this information"
    }, {
      "path": "EHDSImmunisation.header.subject",
      "min": 1,
      "definition": "Patient/subject information",
      "short": "Patient/subject information",
      "type": [ {
        "code": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSPatient"
      } ],
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/obligation",
        "extension": [ {
          "url": "code",
          "valueCode": "SHALL:able-to-populate"
        }, {
          "url": "actor",
          "valueCanonical": "https://www.xt-ehr.eu/specifications/fhir/actor-producer"
        }, {
          "url": "documentation",
          "valueMarkdown": "EHR systems SHALL provide information about the subject of care (patient)."
        }, {
          "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
          "valueCanonical": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationLaboratoryObligations|1.0.0"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/obligation",
        "extension": [ {
          "url": "code",
          "valueCode": "SHALL:display"
        }, {
          "url": "actor",
          "valueCanonical": "https://www.xt-ehr.eu/specifications/fhir/actor-consumer"
        }, {
          "url": "documentation",
          "valueMarkdown": "EHR system SHALL render information about the subject of care in such a way that unambiguous assignment to the care subject is preserved."
        }, {
          "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
          "valueCanonical": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationLaboratoryObligations|1.0.0"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/obligation",
        "extension": [ {
          "url": "code",
          "valueCode": "SHALL:process"
        }, {
          "url": "actor",
          "valueCanonical": "https://www.xt-ehr.eu/specifications/fhir/actor-consumer"
        }, {
          "url": "documentation",
          "valueMarkdown": "Information about the subject of care SHALL be processed by the EHR system in such a way that the identity of the subject of care cannot be confused."
        }, {
          "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
          "valueCanonical": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationLaboratoryObligations|1.0.0"
        } ]
      } ],
      "max": "1",
      "id": "EHDSImmunisation.header.subject",
      "base": {
        "max": "1",
        "min": 1,
        "path": "EHDSDataSet.header.subject"
      }
    }, {
      "id": "EHDSImmunisation.header.identifier",
      "max": "*",
      "min": 0,
      "base": {
        "max": "*",
        "min": 0,
        "path": "EHDSDataSet.header.identifier"
      },
      "path": "EHDSImmunisation.header.identifier",
      "type": [ {
        "code": "Identifier"
      } ],
      "short": "Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries).",
      "definition": "Business identifier for the object, unique within its system. Supporting disambiguation between different contexts (systems/countries)."
    }, {
      "id": "EHDSImmunisation.header.author[x]",
      "max": "*",
      "min": 0,
      "base": {
        "max": "*",
        "min": 0,
        "path": "EHDSDataSet.header.author[x]"
      },
      "path": "EHDSImmunisation.header.author[x]",
      "type": [ {
        "code": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional"
      }, {
        "code": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation"
      }, {
        "code": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDevice"
      } ],
      "short": "The author of the immunisation statement.",
      "definition": "The author of the immunisation statement."
    }, {
      "id": "EHDSImmunisation.header.date",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "EHDSDataSet.header.date"
      },
      "path": "EHDSImmunisation.header.date",
      "type": [ {
        "code": "dateTime"
      } ],
      "short": "Date and optionally time of authoring/issuing",
      "definition": "Date and optionally time of authoring/issuing"
    }, {
      "path": "EHDSImmunisation.header.status",
      "min": 1,
      "definition": "Status of the immunisation event (completed, not-done).",
      "short": "Status of the immunisation event (completed, not-done).",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/obligation",
        "extension": [ {
          "url": "code",
          "valueCode": "SHALL:able-to-populate"
        }, {
          "url": "actor",
          "valueCanonical": "https://www.xt-ehr.eu/specifications/fhir/actor-producer"
        }, {
          "url": "documentation",
          "valueMarkdown": "Immunization status (e.g., “completed\", \"not-done\") SHALL be provided."
        }, {
          "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
          "valueCanonical": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationLaboratoryObligations|1.0.0"
        } ]
      } ],
      "max": "1",
      "id": "EHDSImmunisation.header.status",
      "base": {
        "max": "1",
        "min": 1,
        "path": "EHDSDataSet.header.status"
      }
    }, {
      "id": "EHDSImmunisation.header.source",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "EHDSDataSet.header.source"
      },
      "path": "EHDSImmunisation.header.source",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "short": "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": "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."
    }, {
      "path": "EHDSImmunisation.header.language",
      "min": 0,
      "definition": "Language in which the resource is written. Language is expressed by the IETF language tag.",
      "short": "Language in which the resource is written. Language is expressed by the IETF language tag.",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "binding": {
        "strength": "preferred",
        "description": "BCP 47"
      },
      "max": "1",
      "id": "EHDSImmunisation.header.language",
      "base": {
        "max": "1",
        "min": 0,
        "path": "EHDSDataSet.header.language"
      }
    }, {
      "path": "EHDSImmunisation.diseaseOrAgentTargeted",
      "min": 0,
      "definition": "Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).",
      "short": "Disease or agent that the vaccination provides protection against (e.g. 76902006 Tetanus).",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "binding": {
        "strength": "preferred",
        "description": "ICD-10, SNOMED CT"
      },
      "max": "*",
      "id": "EHDSImmunisation.diseaseOrAgentTargeted",
      "base": {
        "max": "*",
        "min": 0,
        "path": "EHDSImmunisation.diseaseOrAgentTargeted"
      }
    }, {
      "path": "EHDSImmunisation.vaccine",
      "min": 1,
      "definition": "Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.",
      "short": "Type of immunisation, e.g. J07AM01 Tetanus toxoid; or 871803007 Hepatitis A and Hepatitis B virus antigens only vaccine product.",
      "type": [ {
        "code": "CodeableConcept"
      } ],
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/obligation",
        "extension": [ {
          "url": "code",
          "valueCode": "SHALL:able-to-populate"
        }, {
          "url": "actor",
          "valueCanonical": "https://www.xt-ehr.eu/specifications/fhir/actor-producer"
        }, {
          "url": "documentation",
          "valueMarkdown": "Type of immunisation SHELL be provided."
        }, {
          "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
          "valueCanonical": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationLaboratoryObligations|1.0.0"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/obligation",
        "extension": [ {
          "url": "code",
          "valueCode": "SHALL:display"
        }, {
          "url": "actor",
          "valueCanonical": "https://www.xt-ehr.eu/specifications/fhir/actor-consumer"
        }, {
          "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
          "valueCanonical": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationLaboratoryObligations|1.0.0"
        } ]
      } ],
      "binding": {
        "strength": "preferred",
        "description": "SNOMED CT, ATC"
      },
      "max": "1",
      "id": "EHDSImmunisation.vaccine",
      "base": {
        "max": "1",
        "min": 1,
        "path": "EHDSImmunisation.vaccine"
      }
    }, {
      "id": "EHDSImmunisation.administeredProduct",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "EHDSImmunisation.administeredProduct"
      },
      "path": "EHDSImmunisation.administeredProduct",
      "type": [ {
        "code": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSMedication"
      } ],
      "short": "Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary.",
      "definition": "Administered medicinal product (e.g. TETAVAX suspension for injection), including batch/lot details when necessary."
    }, {
      "path": "EHDSImmunisation.administrationTime",
      "min": 1,
      "definition": "The date and optionally the exact time when the vaccination was administered.",
      "short": "The date and optionally the exact time when the vaccination was administered.",
      "type": [ {
        "code": "dateTime"
      } ],
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/obligation",
        "extension": [ {
          "url": "code",
          "valueCode": "SHALL:able-to-populate"
        }, {
          "url": "actor",
          "valueCanonical": "https://www.xt-ehr.eu/specifications/fhir/actor-producer"
        }, {
          "url": "documentation",
          "valueMarkdown": "Time of immunisation SHELL be provided."
        }, {
          "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
          "valueCanonical": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationLaboratoryObligations|1.0.0"
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/obligation",
        "extension": [ {
          "url": "code",
          "valueCode": "SHOULD:display"
        }, {
          "url": "actor",
          "valueCanonical": "https://www.xt-ehr.eu/specifications/fhir/actor-consumer"
        }, {
          "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-source",
          "valueCanonical": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationLaboratoryObligations|1.0.0"
        } ]
      } ],
      "max": "1",
      "id": "EHDSImmunisation.administrationTime",
      "base": {
        "max": "1",
        "min": 1,
        "path": "EHDSImmunisation.administrationTime"
      }
    }, {
      "id": "EHDSImmunisation.administeringCentre",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "EHDSImmunisation.administeringCentre"
      },
      "path": "EHDSImmunisation.administeringCentre",
      "type": [ {
        "code": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation"
      } ],
      "short": "Administering centre or a health authority responsible for the vaccination event",
      "definition": "Administering centre or a health authority responsible for the vaccination event"
    }, {
      "id": "EHDSImmunisation.administrator",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "EHDSImmunisation.administrator"
      },
      "path": "EHDSImmunisation.administrator",
      "type": [ {
        "code": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional"
      } ],
      "short": "Health professional responsible for administering the immunisation product.",
      "definition": "Health professional responsible for administering the immunisation product."
    }, {
      "id": "EHDSImmunisation.note",
      "max": "1",
      "min": 0,
      "base": {
        "max": "1",
        "min": 0,
        "path": "EHDSImmunisation.note"
      },
      "path": "EHDSImmunisation.note",
      "type": [ {
        "code": "string"
      } ],
      "short": "Any additional free-text information about the immunisation",
      "definition": "Any additional free-text information about the immunisation"
    } ],
    "extension": [ {
      "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
      "valueString": "1.0.0"
    } ]
  },
  "status": "active",
  "language": "en",
  "id": "3f793ec3-0ec7-4d09-ac3f-4ee6980bc246",
  "kind": "logical",
  "url": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisationLaboratoryObligations",
  "version": "1.0.0",
  "differential": {
    "element": [ {
      "id": "EHDSImmunisation",
      "path": "EHDSImmunisation"
    }, {
      "id": "EHDSImmunisation.header.subject",
      "path": "EHDSImmunisation.header.subject",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/obligation",
        "extension": [ {
          "url": "code",
          "valueCode": "SHALL:able-to-populate"
        }, {
          "url": "actor",
          "valueCanonical": "https://www.xt-ehr.eu/specifications/fhir/actor-producer"
        }, {
          "url": "documentation",
          "valueMarkdown": "EHR systems SHALL provide information about the subject of care (patient)."
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/obligation",
        "extension": [ {
          "url": "code",
          "valueCode": "SHALL:display"
        }, {
          "url": "actor",
          "valueCanonical": "https://www.xt-ehr.eu/specifications/fhir/actor-consumer"
        }, {
          "url": "documentation",
          "valueMarkdown": "EHR system SHALL render information about the subject of care in such a way that unambiguous assignment to the care subject is preserved."
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/obligation",
        "extension": [ {
          "url": "code",
          "valueCode": "SHALL:process"
        }, {
          "url": "actor",
          "valueCanonical": "https://www.xt-ehr.eu/specifications/fhir/actor-consumer"
        }, {
          "url": "documentation",
          "valueMarkdown": "Information about the subject of care SHALL be processed by the EHR system in such a way that the identity of the subject of care cannot be confused."
        } ]
      } ]
    }, {
      "id": "EHDSImmunisation.header.status",
      "path": "EHDSImmunisation.header.status",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/obligation",
        "extension": [ {
          "url": "code",
          "valueCode": "SHALL:able-to-populate"
        }, {
          "url": "actor",
          "valueCanonical": "https://www.xt-ehr.eu/specifications/fhir/actor-producer"
        }, {
          "url": "documentation",
          "valueMarkdown": "Immunization status (e.g., “completed\", \"not-done\") SHALL be provided."
        } ]
      } ]
    }, {
      "id": "EHDSImmunisation.vaccine",
      "path": "EHDSImmunisation.vaccine",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/obligation",
        "extension": [ {
          "url": "code",
          "valueCode": "SHALL:able-to-populate"
        }, {
          "url": "actor",
          "valueCanonical": "https://www.xt-ehr.eu/specifications/fhir/actor-producer"
        }, {
          "url": "documentation",
          "valueMarkdown": "Type of immunisation SHELL be provided."
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/obligation",
        "extension": [ {
          "url": "code",
          "valueCode": "SHALL:display"
        }, {
          "url": "actor",
          "valueCanonical": "https://www.xt-ehr.eu/specifications/fhir/actor-consumer"
        } ]
      } ]
    }, {
      "id": "EHDSImmunisation.administrationTime",
      "path": "EHDSImmunisation.administrationTime",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/obligation",
        "extension": [ {
          "url": "code",
          "valueCode": "SHALL:able-to-populate"
        }, {
          "url": "actor",
          "valueCanonical": "https://www.xt-ehr.eu/specifications/fhir/actor-producer"
        }, {
          "url": "documentation",
          "valueMarkdown": "Time of immunisation SHELL be provided."
        } ]
      }, {
        "url": "http://hl7.org/fhir/StructureDefinition/obligation",
        "extension": [ {
          "url": "code",
          "valueCode": "SHOULD:display"
        }, {
          "url": "actor",
          "valueCanonical": "https://www.xt-ehr.eu/specifications/fhir/actor-consumer"
        } ]
      } ]
    } ]
  },
  "contact": [ {
    "name": "Xt-EHR",
    "telecom": [ {
      "value": "http://www.xt-ehr.eu/",
      "system": "url"
    } ]
  } ],
  "baseDefinition": "http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSImmunisation"
}