FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/be-vaccination

Packageehealthplatform.be.r4.federalprofiles
TypeStructureDefinition
Idbe-vaccination
FHIR VersionR4
Sourcehttps://www.ehealth.fgov.be/standards/fhir/https://simplifier.net/resolve?scope=ehealthplatform.be.r4.federalprofiles@1.3.3-beta&canonical=https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-vaccination
URLhttps://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-vaccination
Version1.0.0
Statusactive
Date2021-01-10T10:59:49+00:00
NameBeVaccination
TitleBeVaccination
Authorityhl7
DescriptionDefines constraints and extensions on the immunization resource to represent an immunization event i.e. the administration of a vaccine.
TypeImmunization
Kindresource

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
be-ext-administeredProductBeExtAdministeredProduct
be-ext-recorderBeExtRecorder
be-ext-vaccination-confirmationStatusBeExtVaccinationConfirmationStatus
be-ext-vaccination-locationBeExtVaccinationLocation
be-ext-vaccination-originalorderBeExtVaccinationOriginalOrder
be-organizationBeOrganization
be-patientBePatient
be-practitionerBePractitioner
be-practitionerroleBePractitionerRole
ValueSet
be-vs-vaccination-administration-routeVaccine Administration Route
be-vs-vaccination-status-reasonVaccination status reason Value Set

Narrative

Note: links and images are rebased to the (stated) source

NameFlagsCard.TypeDescription & Constraintsdoco
..Immunization0..*ImmunizationImmunization event information
...extension0..*ExtensionExtension
Slice: Unordered, Open by value:url
...be-ext-vaccination-originalorder0..1Reference(ImmunizationRecommendation | MedicationRequest | CarePlan)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-originalorder
...be-ext-administeredProduct0..1Reference(Medication)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-administeredProduct
...be-ext-vaccination-location0..1Reference(Location | BeOrganization)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-location
...be-ext-vaccination-confirmationStatus0..1codeExtension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-confirmationStatus
Binding: Vaccination status Value Set (required)
...be-ext-recorder0..1Reference(BePatient | BePractitioner | BeOrganization)Extension
URL: https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-recorder
...identifierS0..*IdentifierA unique business identifier for a vaccination entry
....systemS1..1uriThe namespace for the identifier value
....valueS1..1stringThe value that is unique
...statusS1..1codeThe status of this vaccination record entry
...statusReasonS0..1CodeableConceptReason not done
Binding: Vaccination status reason Value Set (required)
...vaccineCodeS1..1CodeableConceptThe vaccine code - a type of vaccine, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa
...patientS1..1Reference(BePatient)The patient that this received vaccination entry refers to
...occurrenceDateTimeS0..1dateTimeVaccine administration date
...occurrenceStringS0..1stringVaccine administration date
...recordedS1..1dateTimeThe date/time when the vaccination event has been recorded
...locationS0..0
...lotNumberS0..1stringVaccine lot number
...expirationDateS0..1dateVaccine expiration date
...siteS0..1CodeableConceptBody site vaccine was administered
...routeS0..1CodeableConceptHow vaccine entered body
Binding: Vaccine Administration Route (required)
...performerS0..*BackboneElementWho performed event
....actor1..1Reference(BePractitioner | BeOrganization | BePractitionerRole)Individual or organization who was performing
...reasonCodeS0..*CodeableConceptWhy vaccination has occurred or not (code or text)
...reasonReferenceS0..*Reference(Condition | Observation | DiagnosticReport)Why vaccination has occurred or not (reference to a finding)
...reactionS0..*BackboneElementDetails of a reaction that follows immunization
...protocolAppliedS0..*BackboneElementProtocol followed by the provider
....doseNumberStringS0..1stringWhether this is a first vaccination or a reinforcement
....doseNumberPositiveIntS0..1positiveIntThe numeric/sequential number of the dose, when adequate

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "be-vaccination",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
      "valueString": "Clinical.Medications"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
      "valueCode": "patient"
    }
  ],
  "url": "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-vaccination",
  "version": "1.0.0",
  "name": "BeVaccination",
  "title": "BeVaccination",
  "status": "active",
  "date": "2021-01-10T10:59:49+00:00",
  "publisher": "eHealth Platform",
  "contact": [
    {
      "name": "eHealth Platform",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.ehealth.fgov.be"
        }
      ]
    },
    {
      "name": "Message structure",
      "telecom": [
        {
          "system": "email",
          "value": "message-structure@ehealth.fgov.be"
        }
      ]
    }
  ],
  "description": "Defines constraints and extensions on the immunization resource to represent an immunization event i.e. the administration of a vaccine.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "056"
        },
        {
          "system": "urn:iso:std:iso:3166",
          "code": "BE"
        }
      ]
    }
  ],
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "workflow",
      "uri": "http://hl7.org/fhir/workflow",
      "name": "Workflow Pattern"
    },
    {
      "identity": "v2",
      "uri": "http://hl7.org/v2",
      "name": "HL7 v2 Mapping"
    },
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    },
    {
      "identity": "w5",
      "uri": "http://hl7.org/fhir/fivews",
      "name": "FiveWs Pattern Mapping"
    },
    {
      "identity": "cda",
      "uri": "http://hl7.org/v3/cda",
      "name": "CDA (R2)"
    }
  ],
  "kind": "resource",
  "abstract": false,
  "type": "Immunization",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Immunization.extension",
        "path": "Immunization.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "rules": "open"
        }
      },
      {
        "id": "Immunization.extension:vaccination-originalorder",
        "path": "Immunization.extension",
        "sliceName": "vaccination-originalorder",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-originalorder"
            ]
          }
        ]
      },
      {
        "id": "Immunization.extension:administeredProduct",
        "path": "Immunization.extension",
        "sliceName": "administeredProduct",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-administeredProduct"
            ]
          }
        ]
      },
      {
        "id": "Immunization.extension:vaccination-location",
        "path": "Immunization.extension",
        "sliceName": "vaccination-location",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-location"
            ]
          }
        ]
      },
      {
        "id": "Immunization.extension:vaccination-confirmationStatus",
        "path": "Immunization.extension",
        "sliceName": "vaccination-confirmationStatus",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-vaccination-confirmationStatus"
            ]
          }
        ]
      },
      {
        "id": "Immunization.extension:recorder",
        "path": "Immunization.extension",
        "sliceName": "recorder",
        "max": "1",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-ext-recorder"
            ]
          }
        ]
      },
      {
        "id": "Immunization.identifier",
        "path": "Immunization.identifier",
        "short": "A unique business identifier for a vaccination entry",
        "mustSupport": true
      },
      {
        "id": "Immunization.identifier.system",
        "path": "Immunization.identifier.system",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Immunization.identifier.value",
        "path": "Immunization.identifier.value",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Immunization.status",
        "path": "Immunization.status",
        "short": "The status of this vaccination record entry",
        "mustSupport": true
      },
      {
        "id": "Immunization.statusReason",
        "path": "Immunization.statusReason",
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "valueSet": "https://www.ehealth.fgov.be/standards/fhir/ValueSet/be-vs-vaccination-status-reason"
        }
      },
      {
        "id": "Immunization.vaccineCode",
        "path": "Immunization.vaccineCode",
        "short": "The vaccine code - a type of vaccine, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa",
        "mustSupport": true
      },
      {
        "id": "Immunization.patient",
        "path": "Immunization.patient",
        "short": "The patient that this received vaccination entry refers to",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-patient"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Immunization.occurrenceDateTime",
        "path": "Immunization.occurrenceDateTime",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Immunization.occurrenceString",
        "path": "Immunization.occurrenceString",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Immunization.recorded",
        "path": "Immunization.recorded",
        "short": "The date/time when the vaccination event has been recorded",
        "min": 1,
        "mustSupport": true
      },
      {
        "id": "Immunization.location",
        "path": "Immunization.location",
        "max": "0",
        "mustSupport": false
      },
      {
        "id": "Immunization.lotNumber",
        "path": "Immunization.lotNumber",
        "mustSupport": true
      },
      {
        "id": "Immunization.expirationDate",
        "path": "Immunization.expirationDate",
        "mustSupport": true
      },
      {
        "id": "Immunization.site",
        "path": "Immunization.site",
        "mustSupport": true
      },
      {
        "id": "Immunization.route",
        "path": "Immunization.route",
        "mustSupport": true,
        "binding": {
          "strength": "required",
          "valueSet": "https://www.ehealth.fgov.be/standards/fhir/ValueSet/be-vs-vaccination-administration-route"
        }
      },
      {
        "id": "Immunization.performer",
        "path": "Immunization.performer",
        "mustSupport": true
      },
      {
        "id": "Immunization.performer.actor",
        "path": "Immunization.performer.actor",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-practitioner",
              "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-organization",
              "https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-practitionerrole"
            ]
          }
        ]
      },
      {
        "id": "Immunization.reasonCode",
        "path": "Immunization.reasonCode",
        "short": "Why vaccination has occurred or not (code or text)",
        "mustSupport": true
      },
      {
        "id": "Immunization.reasonReference",
        "path": "Immunization.reasonReference",
        "short": "Why vaccination has occurred or not (reference to a finding)",
        "mustSupport": true
      },
      {
        "id": "Immunization.reaction",
        "path": "Immunization.reaction",
        "mustSupport": true
      },
      {
        "id": "Immunization.protocolApplied",
        "path": "Immunization.protocolApplied",
        "mustSupport": true
      },
      {
        "id": "Immunization.protocolApplied.doseNumberString",
        "path": "Immunization.protocolApplied.doseNumberString",
        "short": "Whether this is a first vaccination or a reinforcement",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Immunization.protocolApplied.doseNumberPositiveInt",
        "path": "Immunization.protocolApplied.doseNumberPositiveInt",
        "short": "The numeric/sequential number of the dose, when adequate",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "positiveInt"
          }
        ],
        "mustSupport": true
      }
    ]
  }
}