FHIR IG analytics| Package | hl7.fhir.uv.xver-r4.r3 |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-profile-Immunization.json |
| FHIR Version | R3 |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition profile-Immunization
FHIR
FHIRsmith
{
"resourceType": "StructureDefinition",
"id": "profile-Immunization",
"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-r4.r3"
},
{
"url": "version",
"valueString": "0.1.0"
}
],
"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-r4.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-r4.r3"
}
]
}
}
],
"url": "http://hl7.org/fhir/4.0/StructureDefinition/profile-Immunization",
"version": "0.1.0",
"name": "Profile_R4_Immunization_R3",
"title": "Cross-version Profile for R4.Immunization for use in FHIR STU3",
"status": "active",
"experimental": false,
"date": "2026-03-17T16:03:29.7150404-05:00",
"publisher": "FHIR Infrastructure",
"contact": [
{
"name": "FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description": "This cross-version profile allows R4 Immunization content to be represented via FHIR STU3 Immunization resources.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"fhirVersion": "3.0.2",
"mapping": [
{
"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/w5",
"name": "W5 Mapping"
},
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow 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",
"snapshot": {
"element": [
{
"id": "Immunization",
"path": "Immunization",
"short": "Immunization event information",
"definition": "Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.",
"min": 0,
"max": "*",
"base": {
"path": "Immunization",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "imm-2",
"severity": "error",
"human": "If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.",
"expression": "(notGiven = true) or explanation.reasonNotGiven.empty()",
"xpath": "not(f:notGiven/@value=false() and exists(f:explanation/f:reasonNotGiven))",
"source": "http://hl7.org/fhir/StructureDefinition/Immunization"
},
{
"key": "imm-1",
"severity": "error",
"human": "If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present",
"expression": "(notGiven = true).not() or (reaction.empty() and explanation.reason.empty())",
"xpath": "not(f:notGiven/@value=true() and (count(f:reaction) > 0 or exists(f:explanation/f:reason)))",
"source": "http://hl7.org/fhir/StructureDefinition/Immunization"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "v2",
"map": "VXU_V04"
},
{
"identity": "rim",
"map": "SubstanceAdministration"
},
{
"identity": "w5",
"map": "clinical.medication"
}
]
},
{
"id": "Immunization.id",
"path": "Immunization.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "Immunization.meta",
"path": "Immunization.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "Immunization.implicitRules",
"path": "Immunization.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "Immunization.language",
"path": "Immunization.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages|3.0.2"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages|3.0.2"
}
}
},
{
"id": "Immunization.text",
"path": "Immunization.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "Immunization.contained",
"path": "Immunization.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Immunization.extension",
"path": "Immunization.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 1,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Immunization.extension:occurrence",
"path": "Immunization.extension",
"sliceName": "occurrence",
"short": "R4: Vaccine administration date additional types",
"definition": "R4: `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": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.occurrence|0.1.0"
}
],
"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": "Immunization.modifierExtension",
"path": "Immunization.modifierExtension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true
},
{
"id": "Immunization.modifierExtension:status",
"path": "Immunization.modifierExtension",
"sliceName": "status",
"short": "R4: completed | entered-in-error | not-done additional codes",
"definition": "R4: `Immunization.status` additional codes",
"comment": "Element `Immunization.status` is mapped to FHIR STU3 element `Immunization.status` as `SourceIsBroaderThanTarget`.\nElement `Immunization.status` is mapped to FHIR STU3 element `Immunization.notGiven` as `SourceIsBroaderThanTarget`.\nThe mappings for `Immunization.status` do not allow expression of the necessary codes, per the bindings on the source and target.\nWill generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.status|0.1.0"
}
],
"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": true
},
{
"id": "Immunization.identifier",
"path": "Immunization.identifier",
"short": "Business identifier",
"definition": "A unique identifier assigned to this immunization record.",
"min": 0,
"max": "*",
"base": {
"path": "Immunization.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"identity": "rim",
"map": ".id"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "Immunization.status",
"path": "Immunization.status",
"short": "completed | entered-in-error",
"definition": "Indicates the current status of the vaccination event.",
"comment": "Will generally be set to show that the immunization has been completed.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min": 1,
"max": "1",
"base": {
"path": "Immunization.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationStatus"
}
],
"strength": "required",
"description": "A set of codes indicating the current status of an Immunization",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-status|3.0.2"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.status"
},
{
"identity": "rim",
"map": "statusCode"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "Immunization.notGiven",
"path": "Immunization.notGiven",
"short": "Flag for whether immunization was given",
"definition": "Indicates if the vaccination was or was not given.",
"comment": "This element is labeled as a modifier because it indicates that an immunization didn't happen.",
"min": 1,
"max": "1",
"base": {
"path": "Immunization.notGiven",
"min": 1,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.notDone"
},
{
"identity": "rim",
"map": "[actionNegationInd=true].reasonCode"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "Immunization.notGiven.id",
"path": "Immunization.notGiven.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references)",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Immunization.notGiven.extension",
"path": "Immunization.notGiven.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Immunization.notGiven.extension:statusReason",
"path": "Immunization.notGiven.extension",
"sliceName": "statusReason",
"short": "R4: Reason not done additional types",
"definition": "R4: `Immunization.statusReason` additional types (CodeableConcept) additional types from child elements (coding, text)",
"comment": "Element `Immunization.statusReason` is mapped to FHIR STU3 element `Immunization.notGiven` as `SourceIsBroaderThanTarget`.\nThe mappings for `Immunization.statusReason` do not cover the following types: CodeableConcept.\nThe mappings for `Immunization.statusReason` do not cover the following types based on type expansion: coding, text.\nThis is generally only used for the status of \"not-done\". The reason for performing the immunization event is captured in reasonCode, not here.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.statusReason|0.1.0"
}
],
"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": "Immunization.notGiven.value",
"path": "Immunization.notGiven.value",
"representation": [
"xmlAttr"
],
"short": "Primitive value for boolean",
"definition": "The actual value",
"min": 0,
"max": "1",
"base": {
"path": "boolean.value",
"min": 0,
"max": "1"
},
"type": [
{
"_code": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString": "boolean"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString": "xsd:boolean"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString": "xsd:boolean"
}
]
}
}
]
},
{
"id": "Immunization.vaccineCode",
"path": "Immunization.vaccineCode",
"short": "Vaccine product administered",
"definition": "Vaccine that was administered or was to be administered.",
"min": 1,
"max": "1",
"base": {
"path": "Immunization.vaccineCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccineCode"
}
],
"strength": "example",
"description": "The code for vaccine product administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/vaccine-code|3.0.2"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.code"
},
{
"identity": "v2",
"map": "RXA-5"
},
{
"identity": "rim",
"map": ".code"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "Immunization.patient",
"path": "Immunization.patient",
"short": "Who was immunized",
"definition": "The patient who either received or did not receive the immunization.",
"min": 1,
"max": "1",
"base": {
"path": "Immunization.patient",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.subject"
},
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"map": ".partipication[ttypeCode=].role"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "Immunization.encounter",
"path": "Immunization.encounter",
"short": "Encounter administered as part of",
"definition": "The visit or admission or other contact between patient and health care provider the immunization was performed as part of.",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.encounter",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.context"
},
{
"identity": "v2",
"map": "PV1-19"
},
{
"identity": "rim",
"map": "component->EncounterEvent"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "Immunization.date",
"path": "Immunization.date",
"short": "Vaccination 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.",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.date",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.occurrence.occurrenceDateTime"
},
{
"identity": "v2",
"map": "RXA-3"
},
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value"
},
{
"identity": "w5",
"map": "when.init"
}
]
},
{
"id": "Immunization.primarySource",
"path": "Immunization.primarySource",
"short": "Indicates context the data was recorded in",
"definition": "An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.",
"comment": "Reflects the “reliability” of the content.",
"min": 1,
"max": "1",
"base": {
"path": "Immunization.primarySource",
"min": 1,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-9"
},
{
"identity": "rim",
"map": "immunization.uncertaintycode (if primary source=false, uncertainty=U)"
},
{
"identity": "w5",
"map": "who.source"
}
]
},
{
"id": "Immunization.reportOrigin",
"path": "Immunization.reportOrigin",
"short": "Indicates the source of a secondarily reported record",
"definition": "The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.",
"comment": "Should not be populated if primarySource = True, will not be required even if primarySource = False.",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.reportOrigin",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationReportOrigin"
}
],
"strength": "example",
"description": "The source of the data for a record which is not from a primary source.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-origin|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXA-9"
},
{
"identity": "rim",
"map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported)\n.participation[typeCode=INF].role[classCode=LIC] (this syntax for health care professional)\n.participation[typeCode=INF].role[classCode=PRS] (this syntax for family member)"
},
{
"identity": "w5",
"map": "who.source"
}
]
},
{
"id": "Immunization.location",
"path": "Immunization.location",
"short": "Where vaccination occurred",
"definition": "The service delivery location where the vaccine administration occurred.",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.location",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-27 (or RXA-11, deprecated as of v2.7)"
},
{
"identity": "rim",
"map": ".participation[typeCode=LOC].COCT_MT240000UV"
},
{
"identity": "w5",
"map": "where"
}
]
},
{
"id": "Immunization.manufacturer",
"path": "Immunization.manufacturer",
"short": "Vaccine manufacturer",
"definition": "Name of vaccine manufacturer.",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.manufacturer",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-17"
},
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name"
}
]
},
{
"id": "Immunization.lotNumber",
"path": "Immunization.lotNumber",
"short": "Vaccine lot number",
"definition": "Lot number of the vaccine product.",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.lotNumber",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-15"
},
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText"
}
]
},
{
"id": "Immunization.expirationDate",
"path": "Immunization.expirationDate",
"short": "Vaccine expiration date",
"definition": "Date vaccine batch expires.",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.expirationDate",
"min": 0,
"max": "1"
},
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-16"
},
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime"
}
]
},
{
"id": "Immunization.site",
"path": "Immunization.site",
"short": "Body site vaccine was administered",
"definition": "Body site where vaccine was administered.",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.site",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationSite"
}
],
"strength": "example",
"description": "The site at which the vaccine was administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-site|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-2"
},
{
"identity": "rim",
"map": "observation.targetSiteCode"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code"
}
]
},
{
"id": "Immunization.route",
"path": "Immunization.route",
"short": "How vaccine entered body",
"definition": "The path by which the vaccine product is taken into the body.",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.route",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationRoute"
}
],
"strength": "example",
"description": "The route by which the vaccine was administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-route|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-1"
},
{
"identity": "rim",
"map": ".routeCode"
},
{
"identity": "cda",
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code"
}
]
},
{
"id": "Immunization.doseQuantity",
"path": "Immunization.doseQuantity",
"short": "Amount of vaccine administered",
"definition": "The quantity of vaccine product that was administered.",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.doseQuantity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-6 / RXA-7.1"
},
{
"identity": "rim",
"map": ".doseQuantity"
}
]
},
{
"id": "Immunization.practitioner",
"path": "Immunization.practitioner",
"short": "Who performed event",
"definition": "Indicates who or what performed the event.",
"min": 0,
"max": "*",
"base": {
"path": "Immunization.practitioner",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"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"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.performer"
},
{
"identity": "v2",
"map": "ORC-12 / RXA-10"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
}
]
},
{
"id": "Immunization.practitioner.id",
"path": "Immunization.practitioner.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": "Immunization.practitioner.extension",
"path": "Immunization.practitioner.extension",
"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": "Immunization.practitioner.modifierExtension",
"path": "Immunization.practitioner.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.",
"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",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Immunization.practitioner.role",
"path": "Immunization.practitioner.role",
"short": "What type of performance was done",
"definition": "Describes the type of performance (e.g. ordering provider, administering provider, etc.).",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.practitioner.role",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationRole"
}
],
"strength": "extensible",
"description": "The role a practitioner plays in the immunization event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-role|3.0.2"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.performer.role"
},
{
"identity": "rim",
"map": ".participation.functionCode"
}
]
},
{
"id": "Immunization.practitioner.actor",
"path": "Immunization.practitioner.actor",
"short": "Individual who was performing",
"definition": "The device, practitioner, etc. who performed the action.",
"min": 1,
"max": "1",
"base": {
"path": "Immunization.practitioner.actor",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.performer.actor"
},
{
"identity": "rim",
"map": ".player"
},
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"id": "Immunization.practitioner.actor.id",
"path": "Immunization.practitioner.actor.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": "Immunization.practitioner.actor.extension",
"path": "Immunization.practitioner.actor.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Immunization.practitioner.actor.extension:actor",
"path": "Immunization.practitioner.actor.extension",
"sliceName": "actor",
"short": "R4: Individual or organization who was performing",
"definition": "R4: `Immunization.performer.actor`",
"comment": "Element `Immunization.performer.actor` is mapped to FHIR STU3 element `Immunization.practitioner.actor` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4 element `Immunization.performer.actor` with unmapped reference targets: Organization, PractitionerRole.\nWhen the individual practitioner who performed the action is known, it is best to send.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "Immunization.practitioner.actor.reference",
"path": "Immunization.practitioner.actor.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Immunization.practitioner.actor.identifier",
"path": "Immunization.practitioner.actor.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "Immunization.practitioner.actor.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "Immunization.practitioner.actor.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Immunization.note",
"path": "Immunization.note",
"short": "Vaccination notes",
"definition": "Extra information about the immunization that is not conveyed by the other attributes.",
"min": 0,
"max": "*",
"base": {
"path": "Immunization.note",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Annotation"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Event.note"
},
{
"identity": "rim",
"map": "note"
}
]
},
{
"id": "Immunization.explanation",
"path": "Immunization.explanation",
"short": "Administration/non-administration reasons",
"definition": "Reasons why a vaccine was or was not administered.",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.explanation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"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"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Immunization.explanation.id",
"path": "Immunization.explanation.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": "Immunization.explanation.extension",
"path": "Immunization.explanation.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Immunization.explanation.extension:recorded",
"path": "Immunization.explanation.extension",
"sliceName": "recorded",
"short": "R4: When the immunization was first captured in the subject's record (new)",
"definition": "R4: `Immunization.recorded` (new:dateTime)",
"comment": "Element `Immunization.recorded` has a context of Immunization.explanation based on following the parent source element upwards and mapping to `Immunization`.\nElement `Immunization.recorded` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.recorded|0.1.0"
}
],
"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": "Immunization.explanation.extension:reasonReference",
"path": "Immunization.explanation.extension",
"sliceName": "reasonReference",
"short": "R4: Why immunization occurred (new)",
"definition": "R4: `Immunization.reasonReference` (new:Reference(Condition,Observation,DiagnosticReport))",
"comment": "Element `Immunization.reasonReference` has a context of Immunization.explanation based on following the parent source element upwards and mapping to `Immunization`.\nElement `Immunization.reasonReference` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.reasonReference|0.1.0"
}
],
"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": "Immunization.explanation.extension:subpotentReason",
"path": "Immunization.explanation.extension",
"sliceName": "subpotentReason",
"short": "R4: Reason for being subpotent (new)",
"definition": "R4: `Immunization.subpotentReason` (new:CodeableConcept)",
"comment": "Element `Immunization.subpotentReason` has a context of Immunization.explanation based on following the parent source element upwards and mapping to `Immunization`.\nElement `Immunization.subpotentReason` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.subpotentReason|0.1.0"
}
],
"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": "Immunization.explanation.extension:education",
"path": "Immunization.explanation.extension",
"sliceName": "education",
"short": "R4: Educational material presented to patient (new)",
"definition": "R4: `Immunization.education` (new:BackboneElement)",
"comment": "Element `Immunization.education` has a context of Immunization.explanation based on following the parent source element upwards and mapping to `Immunization`.\nElement `Immunization.education` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.education|0.1.0"
}
],
"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": "Immunization.explanation.extension:programEligibility",
"path": "Immunization.explanation.extension",
"sliceName": "programEligibility",
"short": "R4: Patient eligibility for a vaccination program (new)",
"definition": "R4: `Immunization.programEligibility` (new:CodeableConcept)",
"comment": "Element `Immunization.programEligibility` has a context of Immunization.explanation based on following the parent source element upwards and mapping to `Immunization`.\nElement `Immunization.programEligibility` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.programEligibility|0.1.0"
}
],
"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": "Immunization.explanation.extension:fundingSource",
"path": "Immunization.explanation.extension",
"sliceName": "fundingSource",
"short": "R4: Funding source for the vaccine (new)",
"definition": "R4: `Immunization.fundingSource` (new:CodeableConcept)",
"comment": "Element `Immunization.fundingSource` has a context of Immunization.explanation based on following the parent source element upwards and mapping to `Immunization`.\nElement `Immunization.fundingSource` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.fundingSource|0.1.0"
}
],
"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": "Immunization.explanation.modifierExtension",
"path": "Immunization.explanation.modifierExtension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "Immunization.explanation.modifierExtension:isSubpotent",
"path": "Immunization.explanation.modifierExtension",
"sliceName": "isSubpotent",
"short": "R4: Dose potency (new)",
"definition": "R4: `Immunization.isSubpotent` (new:boolean)",
"comment": "Element `Immunization.isSubpotent` has a context of Immunization.explanation based on following the parent source element upwards and mapping to `Immunization`.\nElement `Immunization.isSubpotent` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nTypically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.",
"min": 0,
"max": "1",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.isSubpotent|0.1.0"
}
],
"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": true,
"isSummary": true
},
{
"id": "Immunization.explanation.reason",
"path": "Immunization.explanation.reason",
"short": "Why immunization occurred",
"definition": "Reasons why a vaccine was administered.",
"min": 0,
"max": "*",
"base": {
"path": "Immunization.explanation.reason",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationReason"
}
],
"strength": "example",
"description": "The reason why a vaccine was administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-reason|3.0.2"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.reasonCodeableConcept"
},
{
"identity": "rim",
"map": "[actionNegationInd=false].reasonCode"
}
]
},
{
"id": "Immunization.explanation.reasonNotGiven",
"path": "Immunization.explanation.reasonNotGiven",
"short": "Why immunization did not occur",
"definition": "Reason why a vaccine was not administered.",
"min": 0,
"max": "*",
"base": {
"path": "Immunization.explanation.reasonNotGiven",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NoImmunizationReason"
}
],
"strength": "example",
"description": "The reason why a vaccine was not administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/no-immunization-reason|3.0.2"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.notDoneReason"
},
{
"identity": "v2",
"map": "RXA-18"
},
{
"identity": "rim",
"map": "[actionNegationInd=true].reasonCode"
}
]
},
{
"id": "Immunization.reaction",
"path": "Immunization.reaction",
"short": "Details of a reaction that follows immunization",
"definition": "Categorical data indicating that an adverse event is associated in time to an immunization.",
"comment": "A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new [AllergyIntolerance](http://hl7.org/fhir/STU3/allergyintolerance.html) resource instance as most systems will not query against past Immunization.reaction elements.",
"min": 0,
"max": "*",
"base": {
"path": "Immunization.reaction",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"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"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-3"
},
{
"identity": "rim",
"map": "Observation[classCode=obs].code"
}
]
},
{
"id": "Immunization.reaction.id",
"path": "Immunization.reaction.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": "Immunization.reaction.extension",
"path": "Immunization.reaction.extension",
"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": "Immunization.reaction.modifierExtension",
"path": "Immunization.reaction.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.",
"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",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Immunization.reaction.date",
"path": "Immunization.reaction.date",
"short": "When reaction started",
"definition": "Date of reaction to the immunization.",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.reaction.date",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the HL7 v2 VXU message - most likely would appear in OBX segments if at all)"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "Immunization.reaction.detail",
"path": "Immunization.reaction.detail",
"short": "Additional information on reaction",
"definition": "Details of the reaction.",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.reaction.detail",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5"
},
{
"identity": "rim",
"map": ".value"
}
]
},
{
"id": "Immunization.reaction.reported",
"path": "Immunization.reaction.reported",
"short": "Indicates self-reported reaction",
"definition": "Self-reported indicator.",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.reaction.reported",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "v2",
"map": "(no such concept seems to exist for allergy/adverse reaction in HL7 v2)"
},
{
"identity": "rim",
"map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)"
}
]
},
{
"id": "Immunization.vaccinationProtocol",
"path": "Immunization.vaccinationProtocol",
"short": "What protocol was followed",
"definition": "Contains information about the protocol(s) under which the vaccine was administered.",
"min": 0,
"max": "*",
"base": {
"path": "Immunization.vaccinationProtocol",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"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"
}
],
"mapping": [
{
"identity": "v2",
"map": "(HL7 v2 doesn't seem to provide for this)"
},
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM]"
}
]
},
{
"id": "Immunization.vaccinationProtocol.id",
"path": "Immunization.vaccinationProtocol.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": "Immunization.vaccinationProtocol.extension",
"path": "Immunization.vaccinationProtocol.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 1,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Immunization.vaccinationProtocol.extension:doseNumber",
"path": "Immunization.vaccinationProtocol.extension",
"sliceName": "doseNumber",
"short": "R4: Dose number within series additional types",
"definition": "R4: `Immunization.protocolApplied.doseNumber[x]` additional types (string) additional types from child elements (value)",
"comment": "Element `Immunization.protocolApplied.doseNumber[x]` is mapped to FHIR STU3 element `Immunization.vaccinationProtocol.doseSequence` as `SourceIsBroaderThanTarget`.\nThe mappings for `Immunization.protocolApplied.doseNumber[x]` do not cover the following types: string.\nThe mappings for `Immunization.protocolApplied.doseNumber[x]` do not cover the following types based on type expansion: value.\nThe use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).",
"min": 1,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.protocolApplied.doseNumber|0.1.0"
}
],
"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": "Immunization.vaccinationProtocol.extension:seriesDoses",
"path": "Immunization.vaccinationProtocol.extension",
"sliceName": "seriesDoses",
"short": "R4: Recommended number of doses for immunity additional types",
"definition": "R4: `Immunization.protocolApplied.seriesDoses[x]` additional types (string) additional types from child elements (value)",
"comment": "Element `Immunization.protocolApplied.seriesDoses[x]` is mapped to FHIR STU3 element `Immunization.vaccinationProtocol.seriesDoses` as `SourceIsBroaderThanTarget`.\nThe mappings for `Immunization.protocolApplied.seriesDoses[x]` do not cover the following types: string.\nThe mappings for `Immunization.protocolApplied.seriesDoses[x]` do not cover the following types based on type expansion: value.\nThe use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.protocolApplied.seriesDoses|0.1.0"
}
],
"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": "Immunization.vaccinationProtocol.modifierExtension",
"path": "Immunization.vaccinationProtocol.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.",
"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",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Immunization.vaccinationProtocol.doseSequence",
"path": "Immunization.vaccinationProtocol.doseSequence",
"short": "Dose number within series",
"definition": "Nominal position in a series.",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.vaccinationProtocol.doseSequence",
"min": 0,
"max": "1"
},
"type": [
{
"code": "positiveInt"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sequenceNumber"
}
]
},
{
"id": "Immunization.vaccinationProtocol.description",
"path": "Immunization.vaccinationProtocol.description",
"short": "Details of vaccine protocol",
"definition": "Contains the description about the protocol under which the vaccine was administered.",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.vaccinationProtocol.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text"
}
]
},
{
"id": "Immunization.vaccinationProtocol.authority",
"path": "Immunization.vaccinationProtocol.authority",
"short": "Who is responsible for protocol",
"definition": "Indicates the authority who published the protocol. E.g. ACIP.",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.vaccinationProtocol.authority",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].participation[typeCode=AUT].COCT_MT090200UV"
}
]
},
{
"id": "Immunization.vaccinationProtocol.series",
"path": "Immunization.vaccinationProtocol.series",
"short": "Name of vaccine series",
"definition": "One possible path to achieve presumed immunity against a disease - within the context of an authority.",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.vaccinationProtocol.series",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM]"
}
]
},
{
"id": "Immunization.vaccinationProtocol.seriesDoses",
"path": "Immunization.vaccinationProtocol.seriesDoses",
"short": "Recommended number of doses for immunity",
"definition": "The recommended number of doses to achieve immunity.",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.vaccinationProtocol.seriesDoses",
"min": 0,
"max": "1"
},
"type": [
{
"code": "positiveInt"
}
],
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text"
}
]
},
{
"id": "Immunization.vaccinationProtocol.targetDisease",
"path": "Immunization.vaccinationProtocol.targetDisease",
"short": "Disease immunized against",
"definition": "The targeted disease.",
"min": 1,
"max": "*",
"base": {
"path": "Immunization.vaccinationProtocol.targetDisease",
"min": 1,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccinationProtocoltargetDisease"
}
],
"strength": "example",
"description": "The disease target of the vaccination protocol",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-target|3.0.2"
}
},
"mapping": [
{
"identity": "rim",
"map": "outboundRelationship.target[classCode=OBS].code"
}
]
},
{
"id": "Immunization.vaccinationProtocol.doseStatus",
"path": "Immunization.vaccinationProtocol.doseStatus",
"short": "Indicates if dose counts towards immunity",
"definition": "Indicates if the immunization event should \"count\" against the protocol.",
"comment": "May need to differentiate between status declarations by a provider vs. a CDS engine.",
"min": 1,
"max": "1",
"base": {
"path": "Immunization.vaccinationProtocol.doseStatus",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccinationProtocolDoseStatus"
}
],
"strength": "example",
"description": "The status of the vaccination protocol (i.e. should this count)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-status|3.0.2"
}
},
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[classCode=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SBJ].observation[classCode=OBS].value"
}
]
},
{
"id": "Immunization.vaccinationProtocol.doseStatusReason",
"path": "Immunization.vaccinationProtocol.doseStatusReason",
"short": "Why dose does (not) count",
"definition": "Provides an explanation as to why an immunization event should or should not count against the protocol.",
"min": 0,
"max": "1",
"base": {
"path": "Immunization.vaccinationProtocol.doseStatusReason",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccinationProtocolDoseStatusReason"
}
],
"strength": "example",
"description": "The reason for the determining if a vaccination should count or why vaccination should not count.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-status-reason|3.0.2"
}
},
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[classCode=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SBJ].observation[classCode=OBS].reasonCode"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Immunization",
"path": "Immunization"
},
{
"id": "Immunization.extension",
"path": "Immunization.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 1,
"max": "*"
},
{
"id": "Immunization.extension:occurrence",
"path": "Immunization.extension",
"sliceName": "occurrence",
"short": "R4: Vaccine administration date additional types",
"definition": "R4: `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": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.occurrence|0.1.0"
}
]
},
{
"id": "Immunization.modifierExtension",
"path": "Immunization.modifierExtension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Immunization.modifierExtension:status",
"path": "Immunization.modifierExtension",
"sliceName": "status",
"short": "R4: completed | entered-in-error | not-done additional codes",
"definition": "R4: `Immunization.status` additional codes",
"comment": "Element `Immunization.status` is mapped to FHIR STU3 element `Immunization.status` as `SourceIsBroaderThanTarget`.\nElement `Immunization.status` is mapped to FHIR STU3 element `Immunization.notGiven` as `SourceIsBroaderThanTarget`.\nThe mappings for `Immunization.status` do not allow expression of the necessary codes, per the bindings on the source and target.\nWill generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.status|0.1.0"
}
]
},
{
"id": "Immunization.notGiven.extension",
"path": "Immunization.notGiven.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Immunization.notGiven.extension:statusReason",
"path": "Immunization.notGiven.extension",
"sliceName": "statusReason",
"short": "R4: Reason not done additional types",
"definition": "R4: `Immunization.statusReason` additional types (CodeableConcept) additional types from child elements (coding, text)",
"comment": "Element `Immunization.statusReason` is mapped to FHIR STU3 element `Immunization.notGiven` as `SourceIsBroaderThanTarget`.\nThe mappings for `Immunization.statusReason` do not cover the following types: CodeableConcept.\nThe mappings for `Immunization.statusReason` do not cover the following types based on type expansion: coding, text.\nThis is generally only used for the status of \"not-done\". The reason for performing the immunization event is captured in reasonCode, not here.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.statusReason|0.1.0"
}
]
},
{
"id": "Immunization.practitioner.actor.extension",
"path": "Immunization.practitioner.actor.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Immunization.practitioner.actor.extension:actor",
"path": "Immunization.practitioner.actor.extension",
"sliceName": "actor",
"short": "R4: Individual or organization who was performing",
"definition": "R4: `Immunization.performer.actor`",
"comment": "Element `Immunization.performer.actor` is mapped to FHIR STU3 element `Immunization.practitioner.actor` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4 element `Immunization.performer.actor` with unmapped reference targets: Organization, PractitionerRole.\nWhen the individual practitioner who performed the action is known, it is best to send.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "Immunization.explanation.extension",
"path": "Immunization.explanation.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Immunization.explanation.extension:recorded",
"path": "Immunization.explanation.extension",
"sliceName": "recorded",
"short": "R4: When the immunization was first captured in the subject's record (new)",
"definition": "R4: `Immunization.recorded` (new:dateTime)",
"comment": "Element `Immunization.recorded` has a context of Immunization.explanation based on following the parent source element upwards and mapping to `Immunization`.\nElement `Immunization.recorded` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.recorded|0.1.0"
}
]
},
{
"id": "Immunization.explanation.extension:reasonReference",
"path": "Immunization.explanation.extension",
"sliceName": "reasonReference",
"short": "R4: Why immunization occurred (new)",
"definition": "R4: `Immunization.reasonReference` (new:Reference(Condition,Observation,DiagnosticReport))",
"comment": "Element `Immunization.reasonReference` has a context of Immunization.explanation based on following the parent source element upwards and mapping to `Immunization`.\nElement `Immunization.reasonReference` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.reasonReference|0.1.0"
}
]
},
{
"id": "Immunization.explanation.extension:subpotentReason",
"path": "Immunization.explanation.extension",
"sliceName": "subpotentReason",
"short": "R4: Reason for being subpotent (new)",
"definition": "R4: `Immunization.subpotentReason` (new:CodeableConcept)",
"comment": "Element `Immunization.subpotentReason` has a context of Immunization.explanation based on following the parent source element upwards and mapping to `Immunization`.\nElement `Immunization.subpotentReason` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.subpotentReason|0.1.0"
}
]
},
{
"id": "Immunization.explanation.extension:education",
"path": "Immunization.explanation.extension",
"sliceName": "education",
"short": "R4: Educational material presented to patient (new)",
"definition": "R4: `Immunization.education` (new:BackboneElement)",
"comment": "Element `Immunization.education` has a context of Immunization.explanation based on following the parent source element upwards and mapping to `Immunization`.\nElement `Immunization.education` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.education|0.1.0"
}
]
},
{
"id": "Immunization.explanation.extension:programEligibility",
"path": "Immunization.explanation.extension",
"sliceName": "programEligibility",
"short": "R4: Patient eligibility for a vaccination program (new)",
"definition": "R4: `Immunization.programEligibility` (new:CodeableConcept)",
"comment": "Element `Immunization.programEligibility` has a context of Immunization.explanation based on following the parent source element upwards and mapping to `Immunization`.\nElement `Immunization.programEligibility` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.programEligibility|0.1.0"
}
]
},
{
"id": "Immunization.explanation.extension:fundingSource",
"path": "Immunization.explanation.extension",
"sliceName": "fundingSource",
"short": "R4: Funding source for the vaccine (new)",
"definition": "R4: `Immunization.fundingSource` (new:CodeableConcept)",
"comment": "Element `Immunization.fundingSource` has a context of Immunization.explanation based on following the parent source element upwards and mapping to `Immunization`.\nElement `Immunization.fundingSource` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.fundingSource|0.1.0"
}
]
},
{
"id": "Immunization.explanation.modifierExtension",
"path": "Immunization.explanation.modifierExtension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "Immunization.explanation.modifierExtension:isSubpotent",
"path": "Immunization.explanation.modifierExtension",
"sliceName": "isSubpotent",
"short": "R4: Dose potency (new)",
"definition": "R4: `Immunization.isSubpotent` (new:boolean)",
"comment": "Element `Immunization.isSubpotent` has a context of Immunization.explanation based on following the parent source element upwards and mapping to `Immunization`.\nElement `Immunization.isSubpotent` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nTypically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.isSubpotent|0.1.0"
}
]
},
{
"id": "Immunization.vaccinationProtocol.extension",
"path": "Immunization.vaccinationProtocol.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 1,
"max": "*"
},
{
"id": "Immunization.vaccinationProtocol.extension:doseNumber",
"path": "Immunization.vaccinationProtocol.extension",
"sliceName": "doseNumber",
"short": "R4: Dose number within series additional types",
"definition": "R4: `Immunization.protocolApplied.doseNumber[x]` additional types (string) additional types from child elements (value)",
"comment": "Element `Immunization.protocolApplied.doseNumber[x]` is mapped to FHIR STU3 element `Immunization.vaccinationProtocol.doseSequence` as `SourceIsBroaderThanTarget`.\nThe mappings for `Immunization.protocolApplied.doseNumber[x]` do not cover the following types: string.\nThe mappings for `Immunization.protocolApplied.doseNumber[x]` do not cover the following types based on type expansion: value.\nThe use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).",
"min": 1,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.protocolApplied.doseNumber|0.1.0"
}
]
},
{
"id": "Immunization.vaccinationProtocol.extension:seriesDoses",
"path": "Immunization.vaccinationProtocol.extension",
"sliceName": "seriesDoses",
"short": "R4: Recommended number of doses for immunity additional types",
"definition": "R4: `Immunization.protocolApplied.seriesDoses[x]` additional types (string) additional types from child elements (value)",
"comment": "Element `Immunization.protocolApplied.seriesDoses[x]` is mapped to FHIR STU3 element `Immunization.vaccinationProtocol.seriesDoses` as `SourceIsBroaderThanTarget`.\nThe mappings for `Immunization.protocolApplied.seriesDoses[x]` do not cover the following types: string.\nThe mappings for `Immunization.protocolApplied.seriesDoses[x]` do not cover the following types based on type expansion: value.\nThe use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Immunization.protocolApplied.seriesDoses|0.1.0"
}
]
}
]
}
}