FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagech.fhir.ig.ch-ekm
Resource TypeStructureDefinition
IdStructureDefinition-ch-ekm-ext-immunization-unknown.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/ahdis/ch-ekm/StructureDefinition-ch-ekm-ext-immunization-unknown.html
URLhttp://fhir.ch/ig/ch-ekm/StructureDefinition/ch-ekm-ext-immunization-unknown
Version0.0.1
Statusdraft
Date2026-08-26T14:49:37+00:00
NameChEkmExtImmunizationUnknown
TitleCH EKM Extension: Immunization unknown
Realmch
Authorityhl7
DescriptionThis CH EKM modifier extension records that it is NOT KNOWN whether the vaccination described by this Immunization took place ('unbekannt' on the reporting form), as opposed to it being known not to have taken place. It is a modifier extension because the resource carries status = not-done, which without this extension would assert that the vaccination did not happen.
CopyrightCC0-1.0
TypeExtension
Kindcomplex-type

Resources that use this resource

StructureDefinition
ch.fhir.ig.ch-ekm#currentch-ekm-immunizationCH EKM Immunization: Vaccination status

Resources that this resource uses

No resources found


Examples of Use for Extension

ResourceVersion
ch.fhir.ig.ch-ekm#current:Bundle/ChEkmDocumentMpox-extractedR4
ch.fhir.ig.ch-ekm#current:Bundle/ChEkmDocumentMpoxTemplateR4

Narrative

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

Generated Narrative: StructureDefinition ch-ekm-ext-immunization-unknown

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension ?!0..*ExtensionIt is unknown whether this vaccination took place
This is a modifier extension
... extension 0..0Extension
... url 1..1uri"http://fhir.ch/ig/ch-ekm/StructureDefinition/ch-ekm-ext-immunization-unknown"
... value[x] 1..1CodeableConceptAlways sct#261665006 'Unknown' — the extension's presence is the statement
Required Pattern: At least the following

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "ch-ekm-ext-immunization-unknown",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://fhir.ch/ig/ch-ekm/StructureDefinition/ch-ekm-ext-immunization-unknown",
  "version": "0.0.1",
  "name": "ChEkmExtImmunizationUnknown",
  "title": "CH EKM Extension: Immunization unknown",
  "status": "draft",
  "date": "2026-08-26T14:49:37+00:00",
  "publisher": "Federal Office of Public Health FOPH",
  "contact": [
    {
      "name": "Federal Office of Public Health FOPH",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.bag.admin.ch/bag/en/home/das-bag/kontakt-standort.html"
        }
      ]
    }
  ],
  "description": "This CH EKM modifier extension records that it is NOT KNOWN whether the vaccination described by this Immunization took place ('unbekannt' on the reporting form), as opposed to it being known not to have taken place. It is a modifier extension because the resource carries status = not-done, which without this extension would assert that the vaccination did not happen.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "CH"
        }
      ]
    }
  ],
  "copyright": "CC0-1.0",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "complex-type",
  "abstract": false,
  "context": [
    {
      "type": "element",
      "expression": "Immunization"
    }
  ],
  "type": "Extension",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
  "derivation": "constraint",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "4.0.1"
      }
    ],
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "It is unknown whether this vaccination took place",
        "definition": "This CH EKM modifier extension records that it is NOT KNOWN whether the vaccination described by this Immunization took place ('unbekannt' on the reporting form), as opposed to it being known not to have taken place. It is a modifier extension because the resource carries status = not-done, which without this extension would assert that the vaccination did not happen.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Extension",
          "min": 0,
          "max": "*"
        },
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": true,
        "isModifierReason": "Changes the meaning of Immunization.status: the record states that it is unknown whether the vaccination took place, not that it did not take place. A consumer that ignores this extension would read status = not-done as an assertion that the person was not vaccinated."
      },
      {
        "id": "Extension.id",
        "path": "Extension.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "Unique id for inter-element referencing",
        "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "string"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Extension.extension",
        "path": "Extension.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "description": "Extensions are always sliced by (at least) url",
          "rules": "open"
        },
        "short": "Extension",
        "definition": "An Extension",
        "min": 0,
        "max": "0",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": false,
        "isSummary": false
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "representation": [
          "xmlAttr"
        ],
        "short": "identifies the meaning of the extension",
        "definition": "Source of the definition for the extension code - a logical name or a URL.",
        "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.url",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "uri"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "fixedUri": "http://fhir.ch/ig/ch-ekm/StructureDefinition/ch-ekm-ext-immunization-unknown",
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "short": "Always sct#261665006 'Unknown' — the extension's presence is the statement",
        "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.value[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "patternCodeableConcept": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "261665006",
              "display": "Unknown (qualifier value)"
            }
          ]
        },
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "It is unknown whether this vaccination took place",
        "definition": "This CH EKM modifier extension records that it is NOT KNOWN whether the vaccination described by this Immunization took place ('unbekannt' on the reporting form), as opposed to it being known not to have taken place. It is a modifier extension because the resource carries status = not-done, which without this extension would assert that the vaccination did not happen.",
        "isModifier": true,
        "isModifierReason": "Changes the meaning of Immunization.status: the record states that it is unknown whether the vaccination took place, not that it did not take place. A consumer that ignores this extension would read status = not-done as an assertion that the person was not vaccinated."
      },
      {
        "id": "Extension.extension",
        "path": "Extension.extension",
        "max": "0"
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "fixedUri": "http://fhir.ch/ig/ch-ekm/StructureDefinition/ch-ekm-ext-immunization-unknown"
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "short": "Always sct#261665006 'Unknown' — the extension's presence is the statement",
        "min": 1,
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "patternCodeableConcept": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "261665006",
              "display": "Unknown (qualifier value)"
            }
          ]
        }
      }
    ]
  }
}