FHIR IG analytics| Package | hl7.fhir.uv.xver-r5.r3 |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-ext-R5-Immunization.occurrence.json |
| FHIR Version | R3 |
| Source | http://hl7.org/fhir/uv/xver-r5.r3/0.1.0/StructureDefinition-ext-R5-Immunization.occurrence.html |
| URL | http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.occurrence |
| Version | 0.1.0 |
| Status | active |
| Date | 2026-03-17T21:02:03.8104715+00:00 |
| Name | ExtensionImmunization_Occurrence |
| Title | R5: Vaccine administration date additional types |
| Realm | uv |
| Authority | hl7 |
| Description | R5: `Immunization.occurrence[x]` additional types (string) additional types from child elements (value) |
| Purpose | This extension is part of the cross-version definitions generated to enable use of the element `Immunization.occurrence[x]` as defined in FHIR R5 in FHIR STU3. The source element is defined as: `Immunization.occurrence[x]` 1..1 `dateTime, string` Across FHIR versions, the element set has been mapped as: * R5: `Immunization.occurrence[x]` 1..1 `dateTime, string` * R4B: `Immunization.occurrence[x]` 1..1 `dateTime, string` * R4: `Immunization.occurrence[x]` 1..1 `dateTime, string` * STU3: `Immunization.date` 0..1 `dateTime` Following are the generation technical comments: Element `Immunization.occurrence[x]` is mapped to FHIR STU3 element `Immunization.date` as `SourceIsBroaderThanTarget`. The mappings for `Immunization.occurrence[x]` do not cover the following types: string. The mappings for `Immunization.occurrence[x]` do not cover the following types based on type expansion: value. |
| Type | Extension |
| Kind | complex-type |
| ConceptMap | ||
| hl7.fhir.uv.xver-r5.r3#0.1.0 | R5-Immunization-element-map-to-R3 | Cross-version mapping for FHIR R5 Immunization to FHIR STU3 Immunization |
No resources found
No extension usage examples found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition ext-R5-Immunization.occurrence
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Extension | 1..1 | Extension | R5: Vaccine administration date additional types | |
 url | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.occurrence" | |
  value[x] | 1..1 | string | Vaccine administration date | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "ext-R5-Immunization.occurrence",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"extension": [
{
"url": "packageId",
"valueId": "hl7.fhir.uv.xver-r5.r3"
},
{
"url": "version",
"valueString": "0.1.0"
},
{
"url": "uri",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r3"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/package-source"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r3"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r3"
}
]
}
}
],
"url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.occurrence",
"version": "0.1.0",
"name": "ExtensionImmunization_Occurrence",
"title": "R5: Vaccine administration date additional types",
"status": "active",
"experimental": false,
"date": "2026-03-17T21:02:03.8104715+00:00",
"publisher": "FHIR Infrastructure",
"contact": [
{
"name": "FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description": "R5: `Immunization.occurrence[x]` additional types (string) additional types from child elements (value)",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"purpose": "This extension is part of the cross-version definitions generated to enable use of the\r\nelement `Immunization.occurrence[x]` as defined in FHIR R5\r\nin FHIR STU3.\r\n\r\nThe source element is defined as:\r\n`Immunization.occurrence[x]` 1..1 `dateTime, string`\r\n\r\nAcross FHIR versions, the element set has been mapped as:\r\n* R5: `Immunization.occurrence[x]` 1..1 `dateTime, string`\n* R4B: `Immunization.occurrence[x]` 1..1 `dateTime, string`\n* R4: `Immunization.occurrence[x]` 1..1 `dateTime, string`\n* STU3: `Immunization.date` 0..1 `dateTime`\r\n\r\nFollowing are the generation technical comments:\r\nElement `Immunization.occurrence[x]` is mapped to FHIR STU3 element `Immunization.date` as `SourceIsBroaderThanTarget`.\nThe mappings for `Immunization.occurrence[x]` do not cover the following types: string.\nThe mappings for `Immunization.occurrence[x]` do not cover the following types based on type expansion: value.",
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"contextType": "resource",
"context": [
"Immunization"
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "R5: Vaccine administration date additional types",
"definition": "R5: `Immunization.occurrence[x]` additional types (string) additional types from child elements (value)",
"comment": "Element `Immunization.occurrence[x]` is mapped to FHIR STU3 element `Immunization.date` as `SourceIsBroaderThanTarget`.\nThe mappings for `Immunization.occurrence[x]` do not cover the following types: string.\nThe mappings for `Immunization.occurrence[x]` do not cover the following types based on type expansion: value.\nWhen immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.",
"min": 1,
"max": "1",
"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() | (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
},
{
"id": "Extension.id",
"path": "Extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"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": [
{
"code": "string"
}
],
"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": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.occurrence",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Vaccine administration date",
"definition": "Date vaccine administered or was to be administered.",
"comment": "When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "R5: Vaccine administration date additional types",
"definition": "R5: `Immunization.occurrence[x]` additional types (string) additional types from child elements (value)",
"comment": "Element `Immunization.occurrence[x]` is mapped to FHIR STU3 element `Immunization.date` as `SourceIsBroaderThanTarget`.\nThe mappings for `Immunization.occurrence[x]` do not cover the following types: string.\nThe mappings for `Immunization.occurrence[x]` do not cover the following types based on type expansion: value.\nWhen immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.",
"min": 1,
"max": "1",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "Extension.url",
"path": "Extension.url",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.occurrence"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"short": "Vaccine administration date",
"definition": "Date vaccine administered or was to be administered.",
"comment": "When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
}
]
}
}