{
"description": "Immunisation record for Australian context",
"_filename": "StructureDefinition-au-immunisation.json",
"package_name": "hl7.fhir.au.base",
"date": "2018-02-16T17:10:30+11:00",
"derivation": "constraint",
"publisher": "Health Level Seven Australia (Medications WG)",
"fhirVersion": "3.0.1",
"name": "AUBaseImmunisation",
"mapping": [ {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Mapping",
"identity": "workflow"
}, {
"uri": "http://hl7.org/v3/cda",
"name": "CDA (R2)",
"identity": "cda"
} ],
"abstract": false,
"type": "Immunization",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "AU Base Immunisation",
"package_version": "1.0.1",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
}, {
"key": "imm-2",
"human": "If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.",
"xpath": "not(f:notGiven/@value=false() and exists(f:explanation/f:reasonNotGiven))",
"source": "Immunization",
"severity": "error",
"expression": "(notGiven = true) or explanation.reasonNotGiven.empty()"
}, {
"key": "imm-1",
"human": "If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present",
"xpath": "not(f:notGiven/@value=true() and (count(f:reaction) > 0 or exists(f:explanation/f:reason)))",
"source": "Immunization",
"severity": "error",
"expression": "(notGiven = true).not() or (reaction.empty() and explanation.reason.empty())"
} ],
"path": "Immunization",
"min": 0,
"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.",
"short": "An immunisation statement in an Australian healthcare context",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "VXU_V04",
"identity": "v2"
}, {
"map": "SubstanceAdministration",
"identity": "rim"
}, {
"map": "clinical.medication",
"identity": "w5"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ],
"max": "*",
"id": "Immunization",
"base": {
"max": "*",
"min": 0,
"path": "Immunization"
}
}, {
"path": "Immunization.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"short": "Logical id of this artifact",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Immunization.id",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "Immunization.meta",
"min": 0,
"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.",
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Immunization.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Immunization.implicitRules",
"min": 0,
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Immunization.implicitRules",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "Immunization.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Immunization.language",
"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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "Immunization.text",
"min": 0,
"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.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Immunization.text",
"condition": [ "dom-1" ],
"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.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "Immunization.contained",
"min": 0,
"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.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Immunization.contained",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "Immunization.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "Immunization.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "Immunization.identifier",
"min": 0,
"definition": "A unique identifier assigned to this immunization record.",
"short": "Business identifier",
"mapping": [ {
"map": "Event.identifier",
"identity": "workflow"
}, {
"map": ".id",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id",
"identity": "cda"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "Immunization.identifier",
"base": {
"max": "*",
"min": 0,
"path": "Immunization.identifier"
}
}, {
"path": "Immunization.status",
"min": 1,
"definition": "Indicates the current status of the vaccination event.",
"isModifier": true,
"short": "completed | entered-in-error",
"mapping": [ {
"map": "Event.status",
"identity": "workflow"
}, {
"map": "statusCode",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationStatus"
} ],
"description": "A set of codes indicating the current status of an Immunization",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-status"
}
},
"max": "1",
"id": "Immunization.status",
"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.",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.status"
},
"isSummary": true
}, {
"path": "Immunization.notGiven",
"min": 1,
"definition": "Indicates if the vaccination was or was not given.",
"isModifier": true,
"short": "Flag for whether immunization was given",
"mapping": [ {
"map": "Event.notDone",
"identity": "workflow"
}, {
"map": "[actionNegationInd=true].reasonCode",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.notGiven",
"comment": "This element is labeled as a modifier because it indicates that an immunization didn't happen.",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.notGiven"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode",
"min": 1,
"definition": "Vaccine that was administered or was to be administered.",
"short": "Vaccine product administered",
"mapping": [ {
"map": "Event.code",
"identity": "workflow"
}, {
"map": "RXA-5",
"identity": "v2"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code",
"identity": "cda"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccineCode"
} ],
"description": "The code for vaccine product administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/vaccine-code"
}
},
"max": "1",
"id": "Immunization.vaccineCode",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.vaccineCode"
}
}, {
"path": "Immunization.vaccineCode.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccineCode.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.vaccineCode.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccineCode.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.vaccineCode.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "system",
"type": "value"
} ]
},
"type": [ {
"code": "Coding"
} ],
"max": "*",
"id": "Immunization.vaccineCode.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "AMT Vaccine",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "amtVaccineCode",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1"
}
},
"max": "1",
"id": "Immunization.vaccineCode.coding:amtVaccineCode",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "AIR Vaccine",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "airVaccineCode",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1"
}
},
"max": "1",
"id": "Immunization.vaccineCode.coding:airVaccineCode",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.vaccineCode.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "Immunization.patient",
"min": 1,
"definition": "The patient who either received or did not receive the immunization.",
"short": "Who was immunized",
"mapping": [ {
"map": "Event.subject",
"identity": "workflow"
}, {
"map": "PID-3",
"identity": "v2"
}, {
"map": ".partipication[ttypeCode=].role",
"identity": "rim"
}, {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org.au/fhir/StructureDefinition/au-patient"
} ],
"max": "1",
"id": "Immunization.patient",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.patient"
}
}, {
"path": "Immunization.encounter",
"min": 0,
"definition": "The visit or admission or other contact between patient and health care provider the immunization was performed as part of.",
"short": "Encounter administered as part of",
"mapping": [ {
"map": "Event.context",
"identity": "workflow"
}, {
"map": "PV1-19",
"identity": "v2"
}, {
"map": "component->EncounterEvent",
"identity": "rim"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter"
} ],
"max": "1",
"id": "Immunization.encounter",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.encounter"
}
}, {
"path": "Immunization.date",
"min": 0,
"definition": "Date vaccine administered or was to be administered.",
"short": "Vaccination administration date",
"mapping": [ {
"map": "Event.occurrence.occurrenceDateTime",
"identity": "workflow"
}, {
"map": "RXA-3",
"identity": "v2"
}, {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value",
"identity": "cda"
}, {
"map": "when.init",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Immunization.date",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.date"
}
}, {
"path": "Immunization.primarySource",
"min": 1,
"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.",
"short": "Indicates context the data was recorded in",
"mapping": [ {
"map": "RXA-9",
"identity": "v2"
}, {
"map": "immunization.uncertaintycode (if primary source=false, uncertainty=U)",
"identity": "rim"
}, {
"map": "who.source",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.primarySource",
"comment": "Reflects the “reliability” of the content.",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.primarySource"
}
}, {
"path": "Immunization.reportOrigin",
"min": 0,
"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.",
"short": "Indicates the source of a secondarily reported record",
"mapping": [ {
"map": "RXA-9",
"identity": "v2"
}, {
"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": "rim"
}, {
"map": "who.source",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationReportOrigin"
} ],
"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"
}
},
"max": "1",
"id": "Immunization.reportOrigin",
"comment": "Should not be populated if primarySource = True, will not be required even if primarySource = False.",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.reportOrigin"
}
}, {
"path": "Immunization.location",
"min": 0,
"definition": "The service delivery location where the vaccine administration occurred.",
"short": "Where vaccination occurred",
"mapping": [ {
"map": "RXA-27 (or RXA-11, deprecated as of v2.7)",
"identity": "v2"
}, {
"map": ".participation[typeCode=LOC].COCT_MT240000UV",
"identity": "rim"
}, {
"map": "where",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
} ],
"max": "1",
"id": "Immunization.location",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.location"
}
}, {
"path": "Immunization.manufacturer",
"min": 0,
"definition": "Physical vaccine product administered manufacturer.",
"short": "Vaccine product manufacturer",
"mapping": [ {
"map": "RXA-17",
"identity": "v2"
}, {
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org.au/fhir/StructureDefinition/au-organisation"
} ],
"max": "1",
"id": "Immunization.manufacturer",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.manufacturer"
}
}, {
"path": "Immunization.lotNumber",
"min": 0,
"definition": "Lot number of the vaccine product.",
"short": "Vaccine lot number",
"mapping": [ {
"map": "RXA-15",
"identity": "v2"
}, {
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText",
"identity": "cda"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.lotNumber",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.lotNumber"
}
}, {
"path": "Immunization.expirationDate",
"min": 0,
"definition": "Date vaccine batch expires.",
"short": "Vaccine expiration date",
"mapping": [ {
"map": "RXA-16",
"identity": "v2"
}, {
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime",
"identity": "rim"
} ],
"type": [ {
"code": "date"
} ],
"max": "1",
"id": "Immunization.expirationDate",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.expirationDate"
}
}, {
"path": "Immunization.site",
"min": 0,
"definition": "Body site where vaccine was administered.",
"short": "Body site vaccine was administered",
"mapping": [ {
"map": "RXR-2",
"identity": "v2"
}, {
"map": "observation.targetSiteCode",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationSite"
} ],
"description": "The site at which the vaccine was administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-site"
}
},
"max": "1",
"id": "Immunization.site",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.site"
}
}, {
"path": "Immunization.site.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.site.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.site.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.site.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.site.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1"
}
},
"max": "1",
"id": "Immunization.site.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.site.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.site.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "Immunization.route",
"min": 0,
"definition": "The path by which the vaccine product is taken into the body.",
"short": "How vaccine entered body",
"mapping": [ {
"map": "RXR-1",
"identity": "v2"
}, {
"map": ".routeCode",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationRoute"
} ],
"description": "The route by which the vaccine was administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-route"
}
},
"max": "1",
"id": "Immunization.route",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.route"
}
}, {
"path": "Immunization.route.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.route.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.route.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.route.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.route.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "system",
"type": "value"
} ]
},
"type": [ {
"code": "Coding"
} ],
"max": "*",
"id": "Immunization.route.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.route.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Immunisation Route of Administration (SNOMED CT)",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "snomedRoute",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1"
}
},
"max": "1",
"id": "Immunization.route.coding:snomedRoute",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.route.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.route.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "Immunization.doseQuantity",
"min": 0,
"definition": "The quantity of vaccine product that was administered.",
"short": "Amount of vaccine administered",
"mapping": [ {
"map": "RXA-6 / RXA-7.1",
"identity": "v2"
}, {
"map": ".doseQuantity",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
} ],
"max": "1",
"id": "Immunization.doseQuantity",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.doseQuantity"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.practitioner",
"min": 0,
"definition": "Indicates who or what performed the event.",
"short": "Immunisation performer(s)",
"mapping": [ {
"map": "Event.performer",
"identity": "workflow"
}, {
"map": "ORC-12 / RXA-10",
"identity": "v2"
}, {
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "role.coding",
"type": "value"
} ]
},
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "Immunization.practitioner",
"base": {
"max": "*",
"min": 0,
"path": "Immunization.practitioner"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.practitioner.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.practitioner.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.practitioner.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.practitioner.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Immunization.practitioner.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.role",
"min": 0,
"definition": "Describes the type of performance (e.g. ordering provider, administering provider, etc.).",
"short": "What type of performance was done",
"mapping": [ {
"map": "Event.performer.role",
"identity": "workflow"
}, {
"map": ".participation.functionCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationRole"
} ],
"description": "The role a practitioner plays in the immunization event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-role"
}
},
"max": "1",
"id": "Immunization.practitioner.role",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.practitioner.role"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.actor",
"min": 1,
"definition": "The device, practitioner, etc. who performed the action.",
"short": "Individual who was performing",
"mapping": [ {
"map": "Event.performer.actor",
"identity": "workflow"
}, {
"map": ".player",
"identity": "rim"
}, {
"map": "who.actor",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
} ],
"max": "1",
"id": "Immunization.practitioner.actor",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.practitioner.actor"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.practitioner",
"min": 0,
"definition": "Indicates who or what performed the event.",
"short": "Immunisation Administered By",
"mapping": [ {
"map": "Event.performer",
"identity": "workflow"
}, {
"map": "ORC-12 / RXA-10",
"identity": "v2"
}, {
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"sliceName": "administeredBy",
"max": "1",
"id": "Immunization.practitioner:administeredBy",
"base": {
"max": "*",
"min": 0,
"path": "Immunization.practitioner"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.practitioner:administeredBy.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.practitioner.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.practitioner:administeredBy.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.practitioner.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Immunization.practitioner:administeredBy.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.role",
"min": 1,
"definition": "Describes the type of performance (e.g. ordering provider, administering provider, etc.).",
"short": "Administering role",
"mapping": [ {
"map": "Event.performer.role",
"identity": "workflow"
}, {
"map": ".participation.functionCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationRole"
} ],
"description": "The role a practitioner plays in the immunization event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-role"
}
},
"max": "1",
"id": "Immunization.practitioner:administeredBy.role",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.practitioner.role"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.role.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.practitioner:administeredBy.role.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.practitioner.role.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.practitioner:administeredBy.role.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.practitioner.role.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 1,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"fixedCoding": {
"code": "AP",
"system": "http://hl7.org/fhir/v2/0443",
"display": "Administering Provider"
},
"max": "*",
"id": "Immunization.practitioner:administeredBy.role.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.role.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 1,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"fixedString": "Administering Provider",
"id": "Immunization.practitioner:administeredBy.role.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.actor",
"min": 1,
"definition": "The device, practitioner, etc. who performed the action.",
"short": "Administering practitioner",
"mapping": [ {
"map": "Event.performer.actor",
"identity": "workflow"
}, {
"map": ".player",
"identity": "rim"
}, {
"map": "who.actor",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
} ],
"max": "1",
"id": "Immunization.practitioner:administeredBy.actor",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.practitioner.actor"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.practitioner",
"min": 0,
"definition": "Indicates who or what performed the event.",
"short": "Immunisation Approved By",
"mapping": [ {
"map": "Event.performer",
"identity": "workflow"
}, {
"map": "ORC-12 / RXA-10",
"identity": "v2"
}, {
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"sliceName": "approvedBy",
"max": "1",
"id": "Immunization.practitioner:approvedBy",
"base": {
"max": "*",
"min": 0,
"path": "Immunization.practitioner"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.practitioner:approvedBy.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.practitioner.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.practitioner:approvedBy.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.practitioner.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Immunization.practitioner:approvedBy.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.role",
"min": 1,
"definition": "Describes the type of performance (e.g. ordering provider, administering provider, etc.).",
"short": "Approver role",
"mapping": [ {
"map": "Event.performer.role",
"identity": "workflow"
}, {
"map": ".participation.functionCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationRole"
} ],
"description": "The role a practitioner plays in the immunization event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-role"
}
},
"max": "1",
"id": "Immunization.practitioner:approvedBy.role",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.practitioner.role"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.role.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.practitioner:approvedBy.role.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.practitioner.role.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.practitioner:approvedBy.role.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.practitioner.role.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 1,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"fixedCoding": {
"code": "OP",
"system": "http://hl7.org/fhir/v2/0443",
"display": "Ordering Provider"
},
"max": "*",
"id": "Immunization.practitioner:approvedBy.role.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.role.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 1,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"fixedString": "Ordering Provider",
"id": "Immunization.practitioner:approvedBy.role.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.actor",
"min": 1,
"definition": "The device, practitioner, etc. who performed the action.",
"short": "Approving practitioner",
"mapping": [ {
"map": "Event.performer.actor",
"identity": "workflow"
}, {
"map": ".player",
"identity": "rim"
}, {
"map": "who.actor",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
} ],
"max": "1",
"id": "Immunization.practitioner:approvedBy.actor",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.practitioner.actor"
},
"isSummary": true
}, {
"path": "Immunization.note",
"min": 0,
"definition": "Extra information about the immunization that is not conveyed by the other attributes.",
"short": "Vaccination notes",
"mapping": [ {
"map": "Event.note",
"identity": "workflow"
}, {
"map": "note",
"identity": "rim"
} ],
"type": [ {
"code": "Annotation"
} ],
"max": "*",
"id": "Immunization.note",
"base": {
"max": "*",
"min": 0,
"path": "Immunization.note"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation",
"min": 0,
"definition": "Reasons why a vaccine was or was not administered.",
"short": "Administration/non-administration reasons",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "Immunization.explanation",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.explanation"
}
}, {
"path": "Immunization.explanation.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.explanation.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.explanation.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.explanation.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.explanation.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Immunization.explanation.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Immunization.explanation.reason",
"min": 0,
"definition": "Reasons why a vaccine was administered.",
"short": "Why immunization occurred",
"mapping": [ {
"map": "Event.reasonCodeableConcept",
"identity": "workflow"
}, {
"map": "[actionNegationInd=false].reasonCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationReason"
} ],
"description": "The reason why a vaccine was administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-reason"
}
},
"max": "*",
"id": "Immunization.explanation.reason",
"base": {
"max": "*",
"min": 0,
"path": "Immunization.explanation.reason"
}
}, {
"path": "Immunization.explanation.reason.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.explanation.reason.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.explanation.reason.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.explanation.reason.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.explanation.reason.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "system",
"type": "value"
} ]
},
"type": [ {
"code": "Coding"
} ],
"max": "*",
"id": "Immunization.explanation.reason.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.explanation.reason.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Reason Vaccine Administered (SNOMED CT)",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "snomedReason",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1"
}
},
"max": "1",
"id": "Immunization.explanation.reason.coding:snomedReason",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.explanation.reason.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.explanation.reason.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "Immunization.explanation.reasonNotGiven",
"min": 0,
"definition": "Reason why a vaccine was not administered.",
"short": "Reason immunisation did not occur",
"mapping": [ {
"map": "Event.notDoneReason",
"identity": "workflow"
}, {
"map": "RXA-18",
"identity": "v2"
}, {
"map": "[actionNegationInd=true].reasonCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NoImmunizationReason"
} ],
"description": "The reason why a vaccine was not administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/no-immunization-reason"
}
},
"max": "*",
"id": "Immunization.explanation.reasonNotGiven",
"base": {
"max": "*",
"min": 0,
"path": "Immunization.explanation.reasonNotGiven"
}
}, {
"path": "Immunization.explanation.reasonNotGiven.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.explanation.reasonNotGiven.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.explanation.reasonNotGiven.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.explanation.reasonNotGiven.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.explanation.reasonNotGiven.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "system",
"type": "value"
} ]
},
"type": [ {
"code": "Coding"
} ],
"max": "*",
"id": "Immunization.explanation.reasonNotGiven.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.explanation.reasonNotGiven.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Coded Reason (SNOMED CT)",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "snomedReasonCode",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1"
}
},
"max": "*",
"id": "Immunization.explanation.reasonNotGiven.coding:snomedReasonCode",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.explanation.reasonNotGiven.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.explanation.reasonNotGiven.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.reaction",
"min": 0,
"definition": "Categorical data indicating that an adverse event is associated in time to an immunization.",
"short": "Details of a reaction that follows immunization",
"mapping": [ {
"map": "OBX-3",
"identity": "v2"
}, {
"map": "Observation[classCode=obs].code",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "Immunization.reaction",
"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](allergyintolerance.html) resource instance as most systems will not query against past Immunization.reaction elements.",
"base": {
"max": "*",
"min": 0,
"path": "Immunization.reaction"
}
}, {
"path": "Immunization.reaction.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.reaction.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.reaction.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.reaction.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.reaction.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Immunization.reaction.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Immunization.reaction.date",
"min": 0,
"definition": "Date of reaction to the immunization.",
"short": "When reaction started",
"mapping": [ {
"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": "v2"
}, {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Immunization.reaction.date",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.reaction.date"
}
}, {
"path": "Immunization.reaction.detail",
"min": 0,
"definition": "Details of the reaction.",
"short": "Additional information on reaction",
"mapping": [ {
"map": "OBX-5",
"identity": "v2"
}, {
"map": ".value",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation"
} ],
"max": "1",
"id": "Immunization.reaction.detail",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.reaction.detail"
}
}, {
"path": "Immunization.reaction.reported",
"min": 0,
"definition": "Self-reported indicator.",
"short": "Indicates self-reported reaction",
"mapping": [ {
"map": "(no such concept seems to exist for allergy/adverse reaction in HL7 v2)",
"identity": "v2"
}, {
"map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.reaction.reported",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.reaction.reported"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol",
"min": 0,
"definition": "Contains information about the protocol(s) under which the vaccine was administered.",
"short": "What protocol was followed",
"mapping": [ {
"map": "(HL7 v2 doesn't seem to provide for this)",
"identity": "v2"
}, {
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "Immunization.vaccinationProtocol",
"base": {
"max": "*",
"min": 0,
"path": "Immunization.vaccinationProtocol"
}
}, {
"path": "Immunization.vaccinationProtocol.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccinationProtocol.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.vaccinationProtocol.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccinationProtocol.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.vaccinationProtocol.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Immunization.vaccinationProtocol.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Immunization.vaccinationProtocol.doseSequence",
"min": 0,
"definition": "Nominal position in a series.",
"short": "Dose number within series",
"mapping": [ {
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sequenceNumber",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.doseSequence",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.vaccinationProtocol.doseSequence"
}
}, {
"path": "Immunization.vaccinationProtocol.description",
"min": 0,
"definition": "Contains the description about the protocol under which the vaccine was administered.",
"short": "Details of vaccine protocol",
"mapping": [ {
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.description",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.vaccinationProtocol.description"
}
}, {
"path": "Immunization.vaccinationProtocol.authority",
"min": 0,
"definition": "Indicates the authority who published the protocol. E.g. ACIP.",
"short": "Who is responsible for protocol",
"mapping": [ {
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].participation[typeCode=AUT].COCT_MT090200UV",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.authority",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.vaccinationProtocol.authority"
}
}, {
"path": "Immunization.vaccinationProtocol.series",
"min": 0,
"definition": "One possible path to achieve presumed immunity against a disease - within the context of an authority.",
"short": "Name of vaccine series",
"mapping": [ {
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM]",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.series",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.vaccinationProtocol.series"
}
}, {
"path": "Immunization.vaccinationProtocol.seriesDoses",
"min": 0,
"definition": "The recommended number of doses to achieve immunity.",
"short": "Recommended number of doses for immunity",
"mapping": [ {
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.seriesDoses",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.vaccinationProtocol.seriesDoses"
}
}, {
"path": "Immunization.vaccinationProtocol.targetDisease",
"min": 1,
"definition": "The targeted disease.",
"short": "Disease immunized against",
"mapping": [ {
"map": "outboundRelationship.target[classCode=OBS].code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccinationProtocoltargetDisease"
} ],
"description": "The disease target of the vaccination protocol",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-target"
}
},
"max": "*",
"id": "Immunization.vaccinationProtocol.targetDisease",
"base": {
"max": "*",
"min": 1,
"path": "Immunization.vaccinationProtocol.targetDisease"
}
}, {
"path": "Immunization.vaccinationProtocol.targetDisease.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccinationProtocol.targetDisease.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.vaccinationProtocol.targetDisease.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccinationProtocol.targetDisease.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.vaccinationProtocol.targetDisease.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "system",
"type": "value"
} ]
},
"type": [ {
"code": "Coding"
} ],
"max": "*",
"id": "Immunization.vaccinationProtocol.targetDisease.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.vaccinationProtocol.targetDisease.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Vaccination Target Disease (SNOMED CT)",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "snomedTargetDisease",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1"
}
},
"max": "1",
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedTargetDisease",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.vaccinationProtocol.targetDisease.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.targetDisease.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "Immunization.vaccinationProtocol.doseStatus",
"min": 1,
"definition": "Indicates if the immunization event should \"count\" against the protocol.",
"short": "Indicates if dose counts towards immunity",
"mapping": [ {
"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",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccinationProtocolDoseStatus"
} ],
"description": "The status of the vaccination protocol (i.e. should this count)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-status"
}
},
"max": "1",
"id": "Immunization.vaccinationProtocol.doseStatus",
"comment": "May need to differentiate between status declarations by a provider vs. a CDS engine.",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.vaccinationProtocol.doseStatus"
}
}, {
"path": "Immunization.vaccinationProtocol.doseStatus.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccinationProtocol.doseStatus.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.vaccinationProtocol.doseStatus.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccinationProtocol.doseStatus.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.vaccinationProtocol.doseStatus.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "coding",
"type": "value"
} ]
},
"type": [ {
"code": "Coding"
} ],
"max": "*",
"id": "Immunization.vaccinationProtocol.doseStatus.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.vaccinationProtocol.doseStatus.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Dose Status Not Available",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "doseStatusNotAvailable",
"fixedCoding": {
"code": "NAVU",
"system": "http://hl7.org/fhir/v3/NullFlavor",
"display": "Not available"
},
"max": "1",
"id": "Immunization.vaccinationProtocol.doseStatus.coding:doseStatusNotAvailable",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.vaccinationProtocol.doseStatus.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.doseStatus.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "Immunization.vaccinationProtocol.doseStatusReason",
"min": 0,
"definition": "Provides an explanation as to why an immunization event should or should not count against the protocol.",
"short": "Why dose does (not) count",
"mapping": [ {
"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",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccinationProtocolDoseStatusReason"
} ],
"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"
}
},
"max": "1",
"id": "Immunization.vaccinationProtocol.doseStatusReason",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.vaccinationProtocol.doseStatusReason"
}
} ]
},
"status": "draft",
"id": "fe6597b4-daa4-4b0e-9bf8-7427d37920ec",
"kind": "resource",
"url": "http://hl7.org.au/fhir/StructureDefinition/au-immunisation",
"version": "1.0.0",
"differential": {
"element": [ {
"id": "Immunization",
"path": "Immunization",
"short": "An immunisation statement in an Australian healthcare context",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
} ]
}, {
"id": "Immunization.vaccineCode",
"path": "Immunization.vaccineCode"
}, {
"id": "Immunization.vaccineCode.coding",
"path": "Immunization.vaccineCode.coding",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "system",
"type": "value"
} ]
}
}, {
"id": "Immunization.vaccineCode.coding:amtVaccineCode",
"max": "1",
"path": "Immunization.vaccineCode.coding",
"short": "AMT Vaccine",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://healthterminologies.gov.au/fhir/ValueSet/amt-vaccine-1"
}
},
"sliceName": "amtVaccineCode"
}, {
"id": "Immunization.vaccineCode.coding:airVaccineCode",
"max": "1",
"path": "Immunization.vaccineCode.coding",
"short": "AIR Vaccine",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://healthterminologies.gov.au/fhir/ValueSet/australian-immunisation-register-vaccine-1"
}
},
"sliceName": "airVaccineCode"
}, {
"id": "Immunization.patient",
"path": "Immunization.patient",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org.au/fhir/StructureDefinition/au-patient"
} ]
}, {
"id": "Immunization.manufacturer",
"path": "Immunization.manufacturer",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org.au/fhir/StructureDefinition/au-organisation"
} ],
"short": "Vaccine product manufacturer",
"definition": "Physical vaccine product administered manufacturer."
}, {
"id": "Immunization.site",
"path": "Immunization.site"
}, {
"id": "Immunization.site.coding",
"max": "1",
"path": "Immunization.site.coding",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://healthterminologies.gov.au/fhir/ValueSet/immunisation-anatomical-site-1"
}
}
}, {
"id": "Immunization.route",
"path": "Immunization.route"
}, {
"id": "Immunization.route.coding",
"path": "Immunization.route.coding",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "system",
"type": "value"
} ]
}
}, {
"id": "Immunization.route.coding:snomedRoute",
"max": "1",
"path": "Immunization.route.coding",
"short": "Immunisation Route of Administration (SNOMED CT)",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://healthterminologies.gov.au/fhir/ValueSet/immunisation-route-of-administration-1"
}
},
"sliceName": "snomedRoute"
}, {
"id": "Immunization.practitioner",
"path": "Immunization.practitioner",
"short": "Immunisation performer(s)",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "role.coding",
"type": "value"
} ]
}
}, {
"id": "Immunization.practitioner:administeredBy",
"max": "1",
"path": "Immunization.practitioner",
"short": "Immunisation Administered By",
"sliceName": "administeredBy"
}, {
"id": "Immunization.practitioner:administeredBy.role",
"min": 1,
"path": "Immunization.practitioner.role",
"short": "Administering role"
}, {
"id": "Immunization.practitioner:administeredBy.role.coding",
"min": 1,
"path": "Immunization.practitioner.role.coding",
"fixedCoding": {
"code": "AP",
"system": "http://hl7.org/fhir/v2/0443",
"display": "Administering Provider"
}
}, {
"id": "Immunization.practitioner:administeredBy.role.text",
"min": 1,
"path": "Immunization.practitioner.role.text",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"fixedString": "Administering Provider"
}, {
"id": "Immunization.practitioner:administeredBy.actor",
"path": "Immunization.practitioner.actor",
"short": "Administering practitioner"
}, {
"id": "Immunization.practitioner:approvedBy",
"max": "1",
"path": "Immunization.practitioner",
"short": "Immunisation Approved By",
"sliceName": "approvedBy"
}, {
"id": "Immunization.practitioner:approvedBy.role",
"min": 1,
"path": "Immunization.practitioner.role",
"short": "Approver role"
}, {
"id": "Immunization.practitioner:approvedBy.role.coding",
"min": 1,
"path": "Immunization.practitioner.role.coding",
"fixedCoding": {
"code": "OP",
"system": "http://hl7.org/fhir/v2/0443",
"display": "Ordering Provider"
}
}, {
"id": "Immunization.practitioner:approvedBy.role.text",
"min": 1,
"path": "Immunization.practitioner.role.text",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"fixedString": "Ordering Provider"
}, {
"id": "Immunization.practitioner:approvedBy.actor",
"path": "Immunization.practitioner.actor",
"short": "Approving practitioner"
}, {
"id": "Immunization.explanation",
"path": "Immunization.explanation"
}, {
"id": "Immunization.explanation.reason",
"path": "Immunization.explanation.reason"
}, {
"id": "Immunization.explanation.reason.coding",
"path": "Immunization.explanation.reason.coding",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "system",
"type": "value"
} ]
}
}, {
"id": "Immunization.explanation.reason.coding:snomedReason",
"max": "1",
"path": "Immunization.explanation.reason.coding",
"short": "Reason Vaccine Administered (SNOMED CT)",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-administered-1"
}
},
"sliceName": "snomedReason"
}, {
"id": "Immunization.explanation.reasonNotGiven",
"path": "Immunization.explanation.reasonNotGiven",
"short": "Reason immunisation did not occur"
}, {
"id": "Immunization.explanation.reasonNotGiven.coding",
"path": "Immunization.explanation.reasonNotGiven.coding",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "system",
"type": "value"
} ]
}
}, {
"id": "Immunization.explanation.reasonNotGiven.coding:snomedReasonCode",
"path": "Immunization.explanation.reasonNotGiven.coding",
"short": "Coded Reason (SNOMED CT)",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://healthterminologies.gov.au/fhir/ValueSet/reason-vaccine-not-administered-1"
}
},
"sliceName": "snomedReasonCode"
}, {
"id": "Immunization.vaccinationProtocol",
"path": "Immunization.vaccinationProtocol"
}, {
"id": "Immunization.vaccinationProtocol.targetDisease",
"path": "Immunization.vaccinationProtocol.targetDisease"
}, {
"id": "Immunization.vaccinationProtocol.targetDisease.coding",
"path": "Immunization.vaccinationProtocol.targetDisease.coding",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "system",
"type": "value"
} ]
}
}, {
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedTargetDisease",
"max": "1",
"path": "Immunization.vaccinationProtocol.targetDisease.coding",
"short": "Vaccination Target Disease (SNOMED CT)",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "https://healthterminologies.gov.au/fhir/ValueSet/vaccination-target-disease-1"
}
},
"sliceName": "snomedTargetDisease"
}, {
"id": "Immunization.vaccinationProtocol.doseStatus",
"path": "Immunization.vaccinationProtocol.doseStatus"
}, {
"id": "Immunization.vaccinationProtocol.doseStatus.coding",
"path": "Immunization.vaccinationProtocol.doseStatus.coding",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "coding",
"type": "value"
} ]
}
}, {
"id": "Immunization.vaccinationProtocol.doseStatus.coding:doseStatusNotAvailable",
"max": "1",
"path": "Immunization.vaccinationProtocol.doseStatus.coding",
"short": "Dose Status Not Available",
"sliceName": "doseStatusNotAvailable",
"fixedCoding": {
"code": "NAVU",
"system": "http://hl7.org/fhir/v3/NullFlavor",
"display": "Not available"
}
} ]
},
"contact": [ {
"telecom": [ {
"use": "work",
"value": "http://hl7.org.au/fhir",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization"
}