{ "resourceType" : "StructureDefinition", "id" : "air-immunization", "text" : { "status" : "extensions", "div" : "

Generated Narrative: StructureDefinition air-immunization

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Immunization C0..*ImmunizationImmunization event information
Constraints: nz-status-reason-1, nz-status-reason-2, nz-site-1, nz-site-2, nz-route-1, nz-route-2, nz-performer-function-1, nz-performer-function-2, nz-reasonCode-1, nz-reasonCode-2, air-resched-1
\".\"\".\"\".\" meta
\".\"\".\"\".\"\".\" Slices for extension Content/Rules for all slices
\".\"\".\"\".\"\".\"\".\" extension:DataQualityAssessment 0..1(Complex)Data Quality Assessment
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-data-quality-assessment
\".\"\".\"\".\"\".\"\".\" extension:PlannedEventMatch 0..*(Complex)Planned Event Match
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match
\".\"\".\"\".\"\".\"\".\" extension:PlannedEventMatchQuality 0..*(Complex)Planned Event Match Quality
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match-quality
\".\"\".\"\".\"\".\"\".\" extension:CreatedSourceSystem 0..1stringAIR Created Source System
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-created-source-system
\".\"\".\"\".\"\".\"\".\" extension:CreatedBy 0..1stringAIR Created By User
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-created-by
\".\"\".\"\".\"\".\"\".\" extension:ModifiedSourceSystem 0..1stringAIR Modified Source System
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system
\".\"\".\"\".\"\".\"\".\" extension:ModifiedBy 0..1stringAIR Modified By User
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-by
\".\"\".\"\".\"\".\"\".\" extension:CreatedDate 0..1instantThe instant when this resource ID was first associated with content on this server
URL: http://hl7.org/fhir/StructureDefinition/firstCreated
\".\"\".\"\".\" Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
\".\"\".\"\".\"\".\" extension:administeredProduct 0..1CodeableConceptAIR Administered Product Extension
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-administered-product
Binding: AIR Administered Product Code (required)
\".\"\".\"\".\"\".\" extension:Diluent 0..1(Complex)Immunization Diluent
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-diluent
\".\"\".\"\".\"\".\" extension:MobileSiteId 0..1stringImmunization Facility Mobile Site
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-mobile-site
\".\"\".\"\".\"\".\" extension:AgeGiven 0..1(Complex)AIR Age Given Extension
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given
\".\"\".\"\".\"\".\" extension:relatedPersonExtension 0..*Reference(AIR Related Person Profile)AIR Related Person
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-related-person-extension
\".\"\".\"\".\"\".\" extension:serologyReportExtension 0..1Reference(AIR Serology Report Profile)AIR Serology Report Extension
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-serology-report-extension
\".\"\".\"\".\"\".\" extension:rescheduleDateExtension 0..*dateAIR Reschedule Date Extension
URL: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-reschedule-date
\".\"\".\"\".\" statusReason 0..1CodeableConceptReason not done
Binding: AIR Status Reason Code (preferred)
\".\"\".\"\".\"\".\" coding 1..1CodingCode defined by a terminology system
\".\"\".\"\".\" vaccineCode 1..1CodeableConceptVaccine product administered
Binding: AIR Vaccine Product (preferred)
\".\"\".\"\".\"\".\" coding 1..1CodingCode defined by a terminology system
\".\"\".\"\".\"\".\"\".\" system 1..1uriIdentity of the terminology system
\".\"\".\"\".\"\".\"\".\" code 1..1codeSymbol in syntax defined by the system
\".\"\".\"\".\" patient 1..1Reference(Patient)Who was immunized
\".\"\".\"\".\" encounter 0..0Encounter immunization was part of
\".\"\".\"\".\" occurrence[x] 1..1dateTimeVaccine administration date
\".\"\".\"\".\" primarySource 0..0Indicates context the data was recorded in
\".\"\".\"\".\" reportOrigin 0..0Indicates the source of a secondarily reported record
\".\"\".\"\".\" location 0..1Reference(AIR Location Profile)The location where the immunisation was administered.
\".\"\".\"\".\" manufacturer 0..0Vaccine manufacturer
\".\"\".\"\".\" site 0..1CodeableConceptThe body site of the vaccine administration (SNOMED code).
Binding: AIR Body Site (preferred)
\".\"\".\"\".\"\".\" coding 1..1CodingCode defined by a terminology system
\".\"\".\"\".\" route 0..1CodeableConceptThe route of administation of the vaccine.
Binding: AIR Route of Administration (preferred)
\".\"\".\"\".\"\".\" coding 1..1CodingCode defined by a terminology system
\".\"\".\"\".\" doseQuantity 0..0Amount of vaccine administered
\".\"\".\"\".\" performer
\".\"\".\"\".\"\".\" function 0..1CodeableConceptWhat type of performance was done
Binding: AIR Performer Health Worker Function (extensible)
\".\"\".\"\".\"\".\"\".\" coding 1..1CodingCode defined by a terminology system
\".\"\".\"\".\"\".\" actor 1..1Reference(AIR Practitioner Profile)Individual or organization who was performing
\".\"\".\"\".\" note 0..0Additional immunization notes
\".\"\".\"\".\" reasonCode 0..*CodeableConceptWhy immunization occurred
Binding: AIR Indication Code (preferred)
\".\"\".\"\".\" isSubpotent 0..0Dose potency
\".\"\".\"\".\" subpotentReason 0..0Reason for being subpotent
\".\"\".\"\".\" education 0..0Educational material presented to patient
\".\"\".\"\".\" programEligibility 0..0Patient eligibility for a vaccination program
\".\"\".\"\".\" fundingSource 0..0Funding source for the vaccine
\".\"\".\"\".\" reaction 0..0Details of a reaction that follows immunization
\".\"\".\"\".\" protocolApplied 0..1BackboneElementProtocol followed by the provider
\".\"\".\"\".\"\".\" doseNumber[x] 1..1stringDose number within series

\"doco\" Documentation for this format
" }, "url" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization", "version" : "2.7.0", "name" : "AIRImmunization", "title" : "AIR Immunization", "status" : "active", "date" : "2026-07-20T21:32:10+00:00", "publisher" : "Te Whatu Ora", "contact" : [{ "name" : "Te Whatu Ora", "telecom" : [{ "system" : "url", "value" : "https://tewhatuora.govt.nz" }] }], "description" : "This is the AIR Immunization Profile, to be used for immunisation records inbound to ImmSoT. It includes a number of constraints designed to enforce ImmSoT's lean data model approach.", "jurisdiction" : [{ "coding" : [{ "system" : "urn:iso:std:iso:3166", "code" : "US", "display" : "New Zealand" }] }], "fhirVersion" : "4.0.1", "mapping" : [{ "identity" : "workflow", "uri" : "http://hl7.org/fhir/workflow", "name" : "Workflow Pattern" }, { "identity" : "v2", "uri" : "http://hl7.org/v2", "name" : "HL7 v2 Mapping" }, { "identity" : "rim", "uri" : "http://hl7.org/v3", "name" : "RIM Mapping" }, { "identity" : "w5", "uri" : "http://hl7.org/fhir/fivews", "name" : "FiveWs Pattern Mapping" }, { "identity" : "cda", "uri" : "http://hl7.org/v3/cda", "name" : "CDA (R2)" }], "kind" : "resource", "abstract" : false, "type" : "Immunization", "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Immunization", "derivation" : "constraint", "snapshot" : { "extension" : [{ "url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version", "valueString" : "4.0.1" }], "element" : [{ "id" : "Immunization", "path" : "Immunization", "short" : "Immunization event information", "definition" : "Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.", "min" : 0, "max" : "*", "base" : { "path" : "Immunization", "min" : 0, "max" : "*" }, "constraint" : [{ "key" : "dom-2", "severity" : "error", "human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression" : "contained.contained.empty()", "xpath" : "not(parent::f:contained and f:contained)", "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key" : "dom-3", "severity" : "error", "human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource", "expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", "xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key" : "dom-4", "severity" : "error", "human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key" : "dom-5", "severity" : "error", "human" : "If a resource is contained in another resource, it SHALL NOT have a security label", "expression" : "contained.meta.security.empty()", "xpath" : "not(exists(f:contained/*/f:meta/f:security))", "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean" : true }, { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", "valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." }], "key" : "dom-6", "severity" : "warning", "human" : "A resource should have narrative for robust management", "expression" : "text.`div`.exists()", "xpath" : "exists(f:text/h:div)", "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key" : "nz-status-reason-1", "severity" : "error", "human" : "If the status reason has a system, then it must have a code.", "expression" : "statusReason.coding.system.exists() implies statusReason.coding.code.exists()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }, { "key" : "nz-status-reason-2", "severity" : "error", "human" : "If the status reason has a code, then it must have a system.", "expression" : "statusReason.coding.code.exists() implies statusReason.coding.system.exists()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }, { "key" : "nz-site-1", "severity" : "error", "human" : "If the body site has a system, then it must have a code.", "expression" : "site.coding.system.exists() implies site.coding.code.exists()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }, { "key" : "nz-site-2", "severity" : "error", "human" : "If the body site has a code, then it must have a system.", "expression" : "site.coding.code.exists() implies site.coding.system.exists()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }, { "key" : "nz-route-1", "severity" : "error", "human" : "If the route of admin has a system, then it must have a code.", "expression" : "route.coding.system.exists() implies route.coding.code.exists()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }, { "key" : "nz-route-2", "severity" : "error", "human" : "if the route of admin has a code, then it must have a system.", "expression" : "route.coding.code.exists() implies route.coding.system.exists()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }, { "key" : "nz-performer-function-1", "severity" : "error", "human" : "If the performer function has a system, then it must have a code.", "expression" : "performer.function.coding.system.exists() implies performer.function.coding.code.exists()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }, { "key" : "nz-performer-function-2", "severity" : "error", "human" : "If the performer function has a code, then it must have a system.", "expression" : "performer.function.coding.code.exists() implies performer.function.coding.system.exists()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }, { "key" : "nz-reasonCode-1", "severity" : "error", "human" : "If the reasonCode aka indication has a system, then it must have a code.", "expression" : "reasonCode.coding.system.exists() implies reasonCode.coding.code.exists()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }, { "key" : "nz-reasonCode-2", "severity" : "error", "human" : "If the reasonCode aka indication has a code, then it must have a system.", "expression" : "reasonCode.coding.code.exists() implies reasonCode.coding.system.exists()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }, { "key" : "air-resched-1", "severity" : "error", "human" : "Only allow a reschedule date if status NOT DONE and statusReason related to rescheduling.", "expression" : "extension.where(url = 'https://standards.digital.health.nz/fhir/air/StructureDefinition/air-reschedule-date').exists() implies status.value = 'not-done' and statusReason.coding.where(code = 'RESCHO' | 'RESREF' | 'RESTC').allTrue()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "Entity. Role, or Act" }, { "identity" : "workflow", "map" : "Event" }, { "identity" : "v2", "map" : "VXU_V04" }, { "identity" : "rim", "map" : "SubstanceAdministration" }] }, { "id" : "Immunization.id", "path" : "Immunization.id", "short" : "Logical id of this artifact", "definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min" : 0, "max" : "1", "base" : { "path" : "Resource.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "id" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : true }, { "id" : "Immunization.meta", "path" : "Immunization.meta", "short" : "Metadata about the resource", "definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "min" : 0, "max" : "1", "base" : { "path" : "Resource.meta", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Meta" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true }, { "id" : "Immunization.meta.id", "path" : "Immunization.meta.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "string" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.meta.extension", "path" : "Immunization.meta.extension", "slicing" : { "discriminator" : [{ "type" : "value", "path" : "url" }], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "short" : "Additional content defined by implementations", "definition" : "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.meta.extension:DataQualityAssessment", "path" : "Immunization.meta.extension", "sliceName" : "DataQualityAssessment", "short" : "Data Quality Assessment", "definition" : "The data quality assessment of this immunization record as calculated by AIR rules.", "min" : 0, "max" : "1", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-data-quality-assessment"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Immunization.meta.extension:PlannedEventMatch", "path" : "Immunization.meta.extension", "sliceName" : "PlannedEventMatch", "short" : "Planned Event Match", "definition" : "The match of a planned event to an immunisation event as calculated by AIR rules.", "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Immunization.meta.extension:PlannedEventMatchQuality", "path" : "Immunization.meta.extension", "sliceName" : "PlannedEventMatchQuality", "short" : "Planned Event Match Quality", "definition" : "The match quality of a planned event to an immunisation event as calculated by AIR rules.", "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match-quality"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Immunization.meta.extension:CreatedSourceSystem", "path" : "Immunization.meta.extension", "sliceName" : "CreatedSourceSystem", "short" : "AIR Created Source System", "definition" : "This extension is used in AIR to record the system or software used to create the immunisation event record. Example values are ISM, PMS, and so on.", "min" : 0, "max" : "1", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-created-source-system"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Immunization.meta.extension:CreatedBy", "path" : "Immunization.meta.extension", "sliceName" : "CreatedBy", "short" : "AIR Created By User", "definition" : "This extension is used in AIR to record the user who created the immunisation event record.", "min" : 0, "max" : "1", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-created-by"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Immunization.meta.extension:ModifiedSourceSystem", "path" : "Immunization.meta.extension", "sliceName" : "ModifiedSourceSystem", "short" : "AIR Modified Source System", "definition" : "This extension is used in AIR to record the system or software used to update the immunisation event or patient record. Example values are ISM, PMS, and so on.", "min" : 0, "max" : "1", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Immunization.meta.extension:ModifiedBy", "path" : "Immunization.meta.extension", "sliceName" : "ModifiedBy", "short" : "AIR Modified By User", "definition" : "This extension is used in AIR to record the user who modified the immunisation event or patient record.", "min" : 0, "max" : "1", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-by"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Immunization.meta.extension:CreatedDate", "path" : "Immunization.meta.extension", "sliceName" : "CreatedDate", "short" : "The instant when this resource ID was first associated with content on this server", "definition" : "Indicates when this resource ID was first associated with content on this server.", "min" : 0, "max" : "1", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension", "profile" : ["http://hl7.org/fhir/StructureDefinition/firstCreated"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "v2", "map" : "N/A" }, { "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.meta.versionId", "path" : "Immunization.meta.versionId", "short" : "Version specific identifier", "definition" : "The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.", "comment" : "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.", "min" : 0, "max" : "1", "base" : { "path" : "Meta.versionId", "min" : 0, "max" : "1" }, "type" : [{ "code" : "id" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true }, { "id" : "Immunization.meta.lastUpdated", "path" : "Immunization.meta.lastUpdated", "short" : "When the resource version last changed", "definition" : "When the resource last changed - e.g. when the version changed.", "comment" : "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http://hl7.org/fhir/R4/http.html#read) interaction.", "min" : 0, "max" : "1", "base" : { "path" : "Meta.lastUpdated", "min" : 0, "max" : "1" }, "type" : [{ "code" : "instant" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true }, { "id" : "Immunization.meta.source", "path" : "Immunization.meta.source", "short" : "Identifies where the resource comes from", "definition" : "A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](http://hl7.org/fhir/R4/provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.", "comment" : "In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. \n\nThis element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.", "min" : 0, "max" : "1", "base" : { "path" : "Meta.source", "min" : 0, "max" : "1" }, "type" : [{ "code" : "uri" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true }, { "id" : "Immunization.meta.profile", "path" : "Immunization.meta.profile", "short" : "Profiles this resource claims to conform to", "definition" : "A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R4/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R4/structuredefinition-definitions.html#StructureDefinition.url).", "comment" : "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.", "min" : 0, "max" : "*", "base" : { "path" : "Meta.profile", "min" : 0, "max" : "*" }, "type" : [{ "code" : "canonical", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition|4.0.1"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true }, { "id" : "Immunization.meta.security", "path" : "Immunization.meta.security", "short" : "Security Labels applied to this resource", "definition" : "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.", "comment" : "The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.", "min" : 0, "max" : "*", "base" : { "path" : "Meta.security", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Coding" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "SecurityLabels" }], "strength" : "extensible", "description" : "Security Labels from the Healthcare Privacy and Security Classification System.", "valueSet" : "http://hl7.org/fhir/ValueSet/security-labels|4.0.1" } }, { "id" : "Immunization.meta.tag", "path" : "Immunization.meta.tag", "short" : "Tags applied to this resource", "definition" : "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.", "comment" : "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.", "min" : 0, "max" : "*", "base" : { "path" : "Meta.tag", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Coding" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "Tags" }], "strength" : "example", "description" : "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\".", "valueSet" : "http://hl7.org/fhir/ValueSet/common-tags|4.0.1" } }, { "id" : "Immunization.implicitRules", "path" : "Immunization.implicitRules", "short" : "A set of rules under which this content was created", "definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", "min" : 0, "max" : "1", "base" : { "path" : "Resource.implicitRules", "min" : 0, "max" : "1" }, "type" : [{ "code" : "uri" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : true, "isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", "isSummary" : true }, { "id" : "Immunization.language", "path" : "Immunization.language", "short" : "Language of the resource content", "definition" : "The base language in which the resource is written.", "comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "min" : 0, "max" : "1", "base" : { "path" : "Resource.language", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages" }, { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "Language" }], "strength" : "preferred", "description" : "A human language.", "valueSet" : "http://hl7.org/fhir/ValueSet/languages|4.0.1" } }, { "id" : "Immunization.text", "path" : "Immunization.text", "short" : "Text summary of the resource, for human interpretation", "definition" : "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.", "alias" : ["narrative", "html", "xhtml", "display"], "min" : 0, "max" : "1", "base" : { "path" : "DomainResource.text", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Narrative" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "Act.text?" }] }, { "id" : "Immunization.contained", "path" : "Immunization.contained", "short" : "Contained, inline Resources", "definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", "alias" : ["inline resources", "anonymous resources", "contained resources"], "min" : 0, "max" : "*", "base" : { "path" : "DomainResource.contained", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Resource" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.extension", "path" : "Immunization.extension", "slicing" : { "discriminator" : [{ "type" : "value", "path" : "url" }], "ordered" : false, "rules" : "open" }, "short" : "Extension", "definition" : "An Extension", "min" : 0, "max" : "*", "base" : { "path" : "DomainResource.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Immunization.extension:administeredProduct", "path" : "Immunization.extension", "sliceName" : "administeredProduct", "short" : "AIR Administered Product Extension", "definition" : "This extension to the AIR Immunization profile pre-adopts the FHIR R5 construct of the same name. In AIR, the (mandatory) vaccineCode element should be used to transmit a CVX or NZVX code for the vaccine, while the (optional) administeredProduct element should be used to transmit an NZMT TPUU code fot he vaccine.", "min" : 0, "max" : "1", "base" : { "path" : "DomainResource.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-administered-product"] }], "condition" : ["ele-1"], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Immunization.extension:Diluent", "path" : "Immunization.extension", "sliceName" : "Diluent", "short" : "Immunization Diluent", "definition" : "Immunization Diluent", "min" : 0, "max" : "1", "base" : { "path" : "DomainResource.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-diluent"] }], "condition" : ["ele-1"], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Immunization.extension:MobileSiteId", "path" : "Immunization.extension", "sliceName" : "MobileSiteId", "short" : "Immunization Facility Mobile Site", "definition" : "Immunization Facility Mobile Site", "min" : 0, "max" : "1", "base" : { "path" : "DomainResource.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-mobile-site"] }], "condition" : ["ele-1"], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Immunization.extension:AgeGiven", "path" : "Immunization.extension", "sliceName" : "AgeGiven", "short" : "AIR Age Given Extension", "definition" : "This extension calculates the patient age when a vaccination was administered. Although this could be calculated by the client based on patient date of birth, it is provided as a convenience.", "min" : 0, "max" : "1", "base" : { "path" : "DomainResource.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given"] }], "condition" : ["ele-1"], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Immunization.extension:relatedPersonExtension", "path" : "Immunization.extension", "sliceName" : "relatedPersonExtension", "short" : "AIR Related Person", "definition" : "This extension is to be used for communicating related person info in an AIR Immunisation Event. It holds the information transmitted in the HL7v2 NK1 segment.", "min" : 0, "max" : "*", "base" : { "path" : "DomainResource.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-related-person-extension"] }], "condition" : ["ele-1"], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Immunization.extension:serologyReportExtension", "path" : "Immunization.extension", "sliceName" : "serologyReportExtension", "short" : "AIR Serology Report Extension", "definition" : "This extension allows an AIR Immunization instance to contain information from a serology report that describes a patient's expected level of immune protection from Hepatitis B infection. Note that this extension could be updated to cover additional diseases in the future.", "min" : 0, "max" : "1", "base" : { "path" : "DomainResource.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-serology-report-extension"] }], "condition" : ["ele-1"], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Immunization.extension:rescheduleDateExtension", "path" : "Immunization.extension", "sliceName" : "rescheduleDateExtension", "short" : "AIR Reschedule Date Extension", "definition" : "This extension is used on an AIR Immunization resource that is sent to AIR as part of a $bulk-update operation. It holds the date to which the Immunisation Event has been rescheduled.", "min" : 0, "max" : "*", "base" : { "path" : "DomainResource.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-reschedule-date"] }], "condition" : ["ele-1"], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Immunization.modifierExtension", "path" : "Immunization.modifierExtension", "short" : "Extensions that cannot be ignored", "definition" : "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "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.", "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "DomainResource.modifierExtension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : true, "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.identifier", "path" : "Immunization.identifier", "short" : "Business identifier", "definition" : "A unique identifier assigned to this immunization record.", "min" : 0, "max" : "*", "base" : { "path" : "Immunization.identifier", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Identifier" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "workflow", "map" : "Event.identifier" }, { "identity" : "w5", "map" : "FiveWs.identifier" }, { "identity" : "rim", "map" : ".id" }, { "identity" : "cda", "map" : "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id" }] }, { "id" : "Immunization.status", "path" : "Immunization.status", "short" : "completed | entered-in-error | not-done", "definition" : "Indicates the current status of the immunization event.", "comment" : "Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min" : 1, "max" : "1", "base" : { "path" : "Immunization.status", "min" : 1, "max" : "1" }, "type" : [{ "code" : "code" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : true, "isModifierReason" : "This element is labeled as a modifier because it is a status element that contains statuses entered-in-error and not-done which means that the resource should not be treated as valid", "isSummary" : true, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "ImmunizationStatus" }], "strength" : "required", "description" : "A set of codes indicating the current status of an Immunization.", "valueSet" : "http://hl7.org/fhir/ValueSet/immunization-status|4.0.1" }, "mapping" : [{ "identity" : "workflow", "map" : "Event.status" }, { "identity" : "w5", "map" : "FiveWs.status" }, { "identity" : "rim", "map" : "statusCode" }] }, { "id" : "Immunization.statusReason", "path" : "Immunization.statusReason", "short" : "Reason not done", "definition" : "The status reason codes CIS and CPI are included in the Status Reason Code System for backward compatibility, but use of these codes for new events is deprecated.", "comment" : "This is generally only used for the status of \"not-done\". The reason for performing the immunization event is captured in reasonCode, not here.", "min" : 0, "max" : "1", "base" : { "path" : "Immunization.statusReason", "min" : 0, "max" : "1" }, "type" : [{ "code" : "CodeableConcept" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "binding" : { "strength" : "preferred", "valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/air-status-reason-code" }, "mapping" : [{ "identity" : "workflow", "map" : "Event.statusReason" }, { "identity" : "rim", "map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde" }] }, { "id" : "Immunization.statusReason.id", "path" : "Immunization.statusReason.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "string" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.statusReason.extension", "path" : "Immunization.statusReason.extension", "slicing" : { "discriminator" : [{ "type" : "value", "path" : "url" }], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "short" : "Additional content defined by implementations", "definition" : "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.statusReason.coding", "path" : "Immunization.statusReason.coding", "short" : "Code defined by a terminology system", "definition" : "A reference to a code defined by a terminology system.", "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.", "requirements" : "Allows for alternative encodings within a code system, and translations to other code systems.", "min" : 1, "max" : "1", "base" : { "path" : "CodeableConcept.coding", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Coding" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "v2", "map" : "C*E.1-8, C*E.10-22" }, { "identity" : "rim", "map" : "union(., ./translation)" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" }] }, { "id" : "Immunization.statusReason.text", "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true }], "path" : "Immunization.statusReason.text", "short" : "Plain text representation of the concept", "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.", "comment" : "Very often the text is the same as a displayName of one of the codings.", "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, "max" : "1", "base" : { "path" : "CodeableConcept.text", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "v2", "map" : "C*E.9. But note many systems use C*E.2 for this" }, { "identity" : "rim", "map" : "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" }] }, { "id" : "Immunization.vaccineCode", "path" : "Immunization.vaccineCode", "short" : "Vaccine product administered", "definition" : "Vaccine that was administered or was to be administered.", "min" : 1, "max" : "1", "base" : { "path" : "Immunization.vaccineCode", "min" : 1, "max" : "1" }, "type" : [{ "code" : "CodeableConcept" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "binding" : { "strength" : "preferred", "valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/air-vaccine-product-code" }, "mapping" : [{ "identity" : "workflow", "map" : "Event.code" }, { "identity" : "w5", "map" : "FiveWs.what[x]" }, { "identity" : "v2", "map" : "RXA-5" }, { "identity" : "rim", "map" : ".code" }, { "identity" : "cda", "map" : "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code" }] }, { "id" : "Immunization.vaccineCode.id", "path" : "Immunization.vaccineCode.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "string" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.vaccineCode.extension", "path" : "Immunization.vaccineCode.extension", "slicing" : { "discriminator" : [{ "type" : "value", "path" : "url" }], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "short" : "Additional content defined by implementations", "definition" : "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.vaccineCode.coding", "path" : "Immunization.vaccineCode.coding", "short" : "Code defined by a terminology system", "definition" : "A reference to a code defined by a terminology system.", "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.", "requirements" : "Allows for alternative encodings within a code system, and translations to other code systems.", "min" : 1, "max" : "1", "base" : { "path" : "CodeableConcept.coding", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Coding" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "v2", "map" : "C*E.1-8, C*E.10-22" }, { "identity" : "rim", "map" : "union(., ./translation)" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" }] }, { "id" : "Immunization.vaccineCode.coding.id", "path" : "Immunization.vaccineCode.coding.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "string" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.vaccineCode.coding.extension", "path" : "Immunization.vaccineCode.coding.extension", "slicing" : { "discriminator" : [{ "type" : "value", "path" : "url" }], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "short" : "Additional content defined by implementations", "definition" : "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.vaccineCode.coding.system", "path" : "Immunization.vaccineCode.coding.system", "short" : "Identity of the terminology system", "definition" : "The identification of the code system that defines the meaning of the symbol in the code.", "comment" : "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "requirements" : "Need to be unambiguous about the source of the definition of the symbol.", "min" : 1, "max" : "1", "base" : { "path" : "Coding.system", "min" : 0, "max" : "1" }, "type" : [{ "code" : "uri" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "v2", "map" : "C*E.3" }, { "identity" : "rim", "map" : "./codeSystem" }, { "identity" : "orim", "map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" }] }, { "id" : "Immunization.vaccineCode.coding.version", "path" : "Immunization.vaccineCode.coding.version", "short" : "Version of the system - if relevant", "definition" : "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "comment" : "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.version", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "v2", "map" : "C*E.7" }, { "identity" : "rim", "map" : "./codeSystemVersion" }, { "identity" : "orim", "map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" }] }, { "id" : "Immunization.vaccineCode.coding.code", "path" : "Immunization.vaccineCode.coding.code", "short" : "Symbol in syntax defined by the system", "definition" : "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "requirements" : "Need to refer to a particular code in the system.", "min" : 1, "max" : "1", "base" : { "path" : "Coding.code", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "v2", "map" : "C*E.1" }, { "identity" : "rim", "map" : "./code" }, { "identity" : "orim", "map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" }] }, { "id" : "Immunization.vaccineCode.coding.display", "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true }], "path" : "Immunization.vaccineCode.coding.display", "short" : "Representation defined by the system", "definition" : "A representation of the meaning of the code in the system, following the rules of the system.", "requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.display", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "v2", "map" : "C*E.2 - but note this is not well followed" }, { "identity" : "rim", "map" : "CV.displayName" }, { "identity" : "orim", "map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" }] }, { "id" : "Immunization.vaccineCode.coding.userSelected", "path" : "Immunization.vaccineCode.coding.userSelected", "short" : "If this coding was chosen directly by the user", "definition" : "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "comment" : "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "requirements" : "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min" : 0, "max" : "1", "base" : { "path" : "Coding.userSelected", "min" : 0, "max" : "1" }, "type" : [{ "code" : "boolean" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "v2", "map" : "Sometimes implied by being first" }, { "identity" : "rim", "map" : "CD.codingRationale" }, { "identity" : "orim", "map" : "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" }] }, { "id" : "Immunization.vaccineCode.text", "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true }], "path" : "Immunization.vaccineCode.text", "short" : "Plain text representation of the concept", "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.", "comment" : "Very often the text is the same as a displayName of one of the codings.", "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, "max" : "1", "base" : { "path" : "CodeableConcept.text", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "v2", "map" : "C*E.9. But note many systems use C*E.2 for this" }, { "identity" : "rim", "map" : "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" }] }, { "id" : "Immunization.patient", "path" : "Immunization.patient", "short" : "Who was immunized", "definition" : "The patient should be sent using the logical reference format, specifically an identifier with a system and a value. The identifier must be the NZ NHI number.", "min" : 1, "max" : "1", "base" : { "path" : "Immunization.patient", "min" : 1, "max" : "1" }, "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient|4.0.1"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Event.subject" }, { "identity" : "w5", "map" : "FiveWs.subject[x]" }, { "identity" : "v2", "map" : "PID-3" }, { "identity" : "rim", "map" : ".partipication[ttypeCode=].role" }, { "identity" : "w5", "map" : "FiveWs.subject" }] }, { "id" : "Immunization.encounter", "path" : "Immunization.encounter", "short" : "Encounter immunization was part of", "definition" : "The visit or admission or other contact between patient and health care provider the immunization was performed as part of.", "min" : 0, "max" : "0", "base" : { "path" : "Immunization.encounter", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter|4.0.1"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "workflow", "map" : "Event.context" }, { "identity" : "w5", "map" : "FiveWs.context" }, { "identity" : "v2", "map" : "PV1-19" }, { "identity" : "rim", "map" : "component->EncounterEvent" }] }, { "id" : "Immunization.occurrence[x]", "path" : "Immunization.occurrence[x]", "short" : "Vaccine administration date", "definition" : "Date vaccine administered or was to be administered.", "comment" : "When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.", "min" : 1, "max" : "1", "base" : { "path" : "Immunization.occurrence[x]", "min" : 1, "max" : "1" }, "type" : [{ "code" : "dateTime" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Event.occurrence[x]" }, { "identity" : "w5", "map" : "FiveWs.done[x]" }, { "identity" : "v2", "map" : "RXA-3" }, { "identity" : "rim", "map" : ".effectiveTime" }, { "identity" : "cda", "map" : "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value" }] }, { "id" : "Immunization.recorded", "path" : "Immunization.recorded", "short" : "When the immunization was first captured in the subject's record", "definition" : "The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.", "min" : 0, "max" : "1", "base" : { "path" : "Immunization.recorded", "min" : 0, "max" : "1" }, "type" : [{ "code" : "dateTime" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "w5", "map" : "FiveWs.recorded" }, { "identity" : "rim", "map" : ".participation[typeCode=AUT].time" }] }, { "id" : "Immunization.primarySource", "path" : "Immunization.primarySource", "short" : "Indicates context the data was recorded in", "definition" : "An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.", "comment" : "Reflects the “reliability” of the content.", "min" : 0, "max" : "0", "base" : { "path" : "Immunization.primarySource", "min" : 0, "max" : "1" }, "type" : [{ "code" : "boolean" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "w5", "map" : "FiveWs.source" }, { "identity" : "v2", "map" : "RXA-9" }, { "identity" : "rim", "map" : "immunization.uncertaintycode (if primary source=false, uncertainty=U)" }] }, { "id" : "Immunization.reportOrigin", "path" : "Immunization.reportOrigin", "short" : "Indicates the source of a secondarily reported record", "definition" : "The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.", "comment" : "Should not be populated if primarySource = True, not required even if primarySource = False.", "min" : 0, "max" : "0", "base" : { "path" : "Immunization.reportOrigin", "min" : 0, "max" : "1" }, "type" : [{ "code" : "CodeableConcept" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "ImmunizationReportOrigin" }], "strength" : "example", "description" : "The source of the data for a record which is not from a primary source.", "valueSet" : "http://hl7.org/fhir/ValueSet/immunization-origin|4.0.1" }, "mapping" : [{ "identity" : "w5", "map" : "FiveWs.source" }, { "identity" : "v2", "map" : "RXA-9" }, { "identity" : "rim", "map" : ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported) .participation[typeCode=INF].role[classCode=LIC] (this syntax for health care professional) .participation[typeCode=INF].role[classCode=PRS] (this syntax for family member)" }] }, { "id" : "Immunization.location", "path" : "Immunization.location", "short" : "The location where the immunisation was administered.", "definition" : "The location should be sent using the logical reference format, specifically an identifier with a system and a value. The required identification system is the HPI-F. See the HPI Implementation Guide at https://hpi-ig.hip.digital.health.nz/index.html. ", "min" : 0, "max" : "1", "base" : { "path" : "Immunization.location", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Reference", "targetProfile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-location"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "workflow", "map" : "Event.location" }, { "identity" : "w5", "map" : "FiveWs.where[x]" }, { "identity" : "v2", "map" : "RXA-27 (or RXA-11, deprecated as of v2.7)" }, { "identity" : "rim", "map" : ".participation[typeCode=LOC].COCT_MT240000UV" }] }, { "id" : "Immunization.manufacturer", "path" : "Immunization.manufacturer", "short" : "Vaccine manufacturer", "definition" : "Name of vaccine manufacturer.", "min" : 0, "max" : "0", "base" : { "path" : "Immunization.manufacturer", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization|4.0.1"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "v2", "map" : "RXA-17" }, { "identity" : "rim", "map" : ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]" }, { "identity" : "cda", "map" : "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name" }] }, { "id" : "Immunization.lotNumber", "path" : "Immunization.lotNumber", "short" : "Vaccine lot number", "definition" : "Lot number of the vaccine product.", "min" : 0, "max" : "1", "base" : { "path" : "Immunization.lotNumber", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "v2", "map" : "RXA-15" }, { "identity" : "rim", "map" : ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id" }, { "identity" : "cda", "map" : "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText" }] }, { "id" : "Immunization.expirationDate", "path" : "Immunization.expirationDate", "short" : "Vaccine expiration date", "definition" : "Date vaccine batch expires.", "min" : 0, "max" : "1", "base" : { "path" : "Immunization.expirationDate", "min" : 0, "max" : "1" }, "type" : [{ "code" : "date" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "v2", "map" : "RXA-16" }, { "identity" : "rim", "map" : ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime" }] }, { "id" : "Immunization.site", "path" : "Immunization.site", "short" : "The body site of the vaccine administration (SNOMED code).", "definition" : "Body site where vaccine was administered.", "min" : 0, "max" : "1", "base" : { "path" : "Immunization.site", "min" : 0, "max" : "1" }, "type" : [{ "code" : "CodeableConcept" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "binding" : { "strength" : "preferred", "valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/air-site-code" }, "mapping" : [{ "identity" : "v2", "map" : "RXR-2" }, { "identity" : "rim", "map" : "observation.targetSiteCode" }, { "identity" : "cda", "map" : "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code" }] }, { "id" : "Immunization.site.id", "path" : "Immunization.site.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "string" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.site.extension", "path" : "Immunization.site.extension", "slicing" : { "discriminator" : [{ "type" : "value", "path" : "url" }], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "short" : "Additional content defined by implementations", "definition" : "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.site.coding", "path" : "Immunization.site.coding", "short" : "Code defined by a terminology system", "definition" : "A reference to a code defined by a terminology system.", "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.", "requirements" : "Allows for alternative encodings within a code system, and translations to other code systems.", "min" : 1, "max" : "1", "base" : { "path" : "CodeableConcept.coding", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Coding" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "v2", "map" : "C*E.1-8, C*E.10-22" }, { "identity" : "rim", "map" : "union(., ./translation)" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" }] }, { "id" : "Immunization.site.text", "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true }], "path" : "Immunization.site.text", "short" : "Plain text representation of the concept", "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.", "comment" : "Very often the text is the same as a displayName of one of the codings.", "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, "max" : "1", "base" : { "path" : "CodeableConcept.text", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "v2", "map" : "C*E.9. But note many systems use C*E.2 for this" }, { "identity" : "rim", "map" : "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" }] }, { "id" : "Immunization.route", "path" : "Immunization.route", "short" : "The route of administation of the vaccine.", "definition" : "The path by which the vaccine product is taken into the body.", "min" : 0, "max" : "1", "base" : { "path" : "Immunization.route", "min" : 0, "max" : "1" }, "type" : [{ "code" : "CodeableConcept" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "binding" : { "strength" : "preferred", "valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/air-route-code" }, "mapping" : [{ "identity" : "v2", "map" : "RXR-1" }, { "identity" : "rim", "map" : ".routeCode" }, { "identity" : "cda", "map" : "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code" }] }, { "id" : "Immunization.route.id", "path" : "Immunization.route.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "string" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.route.extension", "path" : "Immunization.route.extension", "slicing" : { "discriminator" : [{ "type" : "value", "path" : "url" }], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "short" : "Additional content defined by implementations", "definition" : "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.route.coding", "path" : "Immunization.route.coding", "short" : "Code defined by a terminology system", "definition" : "A reference to a code defined by a terminology system.", "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.", "requirements" : "Allows for alternative encodings within a code system, and translations to other code systems.", "min" : 1, "max" : "1", "base" : { "path" : "CodeableConcept.coding", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Coding" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "v2", "map" : "C*E.1-8, C*E.10-22" }, { "identity" : "rim", "map" : "union(., ./translation)" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" }] }, { "id" : "Immunization.route.text", "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true }], "path" : "Immunization.route.text", "short" : "Plain text representation of the concept", "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.", "comment" : "Very often the text is the same as a displayName of one of the codings.", "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, "max" : "1", "base" : { "path" : "CodeableConcept.text", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "v2", "map" : "C*E.9. But note many systems use C*E.2 for this" }, { "identity" : "rim", "map" : "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" }] }, { "id" : "Immunization.doseQuantity", "path" : "Immunization.doseQuantity", "short" : "Amount of vaccine administered", "definition" : "The quantity of vaccine product that was administered.", "min" : 0, "max" : "0", "base" : { "path" : "Immunization.doseQuantity", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Quantity", "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity|4.0.1"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "v2", "map" : "RXA-6 / RXA-7" }, { "identity" : "rim", "map" : ".doseQuantity" }] }, { "id" : "Immunization.performer", "path" : "Immunization.performer", "short" : "Who performed event", "definition" : "Indicates who performed the immunization event.", "min" : 0, "max" : "*", "base" : { "path" : "Immunization.performer", "min" : 0, "max" : "*" }, "type" : [{ "code" : "BackboneElement" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Event.performer" }, { "identity" : "v2", "map" : "ORC-12 / RXA-10" }, { "identity" : "rim", "map" : ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]" }] }, { "id" : "Immunization.performer.id", "path" : "Immunization.performer.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "string" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.performer.extension", "path" : "Immunization.performer.extension", "short" : "Additional content defined by implementations", "definition" : "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.performer.modifierExtension", "path" : "Immunization.performer.modifierExtension", "short" : "Extensions that cannot be ignored even if unrecognized", "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "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.", "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias" : ["extensions", "user content", "modifiers"], "min" : 0, "max" : "*", "base" : { "path" : "BackboneElement.modifierExtension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : true, "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary" : true, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.performer.function", "path" : "Immunization.performer.function", "short" : "What type of performance was done", "definition" : "Describes the type of performance (e.g. ordering provider, administering provider, etc.).", "min" : 0, "max" : "1", "base" : { "path" : "Immunization.performer.function", "min" : 0, "max" : "1" }, "type" : [{ "code" : "CodeableConcept" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "binding" : { "strength" : "extensible", "valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/air-performer-health-worker-function-code" }, "mapping" : [{ "identity" : "workflow", "map" : "Event.performer.function" }, { "identity" : "rim", "map" : ".participation.functionCode" }] }, { "id" : "Immunization.performer.function.id", "path" : "Immunization.performer.function.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "string" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.performer.function.extension", "path" : "Immunization.performer.function.extension", "slicing" : { "discriminator" : [{ "type" : "value", "path" : "url" }], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "short" : "Additional content defined by implementations", "definition" : "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.performer.function.coding", "path" : "Immunization.performer.function.coding", "short" : "Code defined by a terminology system", "definition" : "A reference to a code defined by a terminology system.", "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.", "requirements" : "Allows for alternative encodings within a code system, and translations to other code systems.", "min" : 1, "max" : "1", "base" : { "path" : "CodeableConcept.coding", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Coding" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "v2", "map" : "C*E.1-8, C*E.10-22" }, { "identity" : "rim", "map" : "union(., ./translation)" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" }] }, { "id" : "Immunization.performer.function.text", "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean" : true }], "path" : "Immunization.performer.function.text", "short" : "Plain text representation of the concept", "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.", "comment" : "Very often the text is the same as a displayName of one of the codings.", "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, "max" : "1", "base" : { "path" : "CodeableConcept.text", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "v2", "map" : "C*E.9. But note many systems use C*E.2 for this" }, { "identity" : "rim", "map" : "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity" : "orim", "map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" }] }, { "id" : "Immunization.performer.actor", "path" : "Immunization.performer.actor", "short" : "Individual or organization who was performing", "definition" : "The practitioner or organization who performed the action.", "comment" : "When the individual practitioner who performed the action is known, it is best to send.", "min" : 1, "max" : "1", "base" : { "path" : "Immunization.performer.actor", "min" : 1, "max" : "1" }, "type" : [{ "code" : "Reference", "targetProfile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-practitioner"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Event.performer.actor" }, { "identity" : "w5", "map" : "FiveWs.actor" }, { "identity" : "rim", "map" : ".player" }] }, { "id" : "Immunization.note", "path" : "Immunization.note", "short" : "Additional immunization notes", "definition" : "Extra information about the immunization that is not conveyed by the other attributes.", "min" : 0, "max" : "0", "base" : { "path" : "Immunization.note", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Annotation" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Event.note" }, { "identity" : "v2", "map" : "OBX-5 : OBX-3 = 48767-8" }, { "identity" : "rim", "map" : "note" }] }, { "id" : "Immunization.reasonCode", "path" : "Immunization.reasonCode", "short" : "Why immunization occurred", "definition" : "Reasons why the vaccine was administered.", "min" : 0, "max" : "*", "base" : { "path" : "Immunization.reasonCode", "min" : 0, "max" : "*" }, "type" : [{ "code" : "CodeableConcept" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "binding" : { "strength" : "preferred", "valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/air-indication-code" }, "mapping" : [{ "identity" : "workflow", "map" : "Event.reasonCode" }, { "identity" : "rim", "map" : "[actionNegationInd=false].reasonCode" }] }, { "id" : "Immunization.reasonReference", "path" : "Immunization.reasonReference", "short" : "Why immunization occurred", "definition" : "Condition, Observation or DiagnosticReport that supports why the immunization was administered.", "min" : 0, "max" : "*", "base" : { "path" : "Immunization.reasonReference", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition|4.0.1", "http://hl7.org/fhir/StructureDefinition/Observation|4.0.1", "http://hl7.org/fhir/StructureDefinition/DiagnosticReport|4.0.1"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "workflow", "map" : "Event.reasonReference" }, { "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.isSubpotent", "path" : "Immunization.isSubpotent", "short" : "Dose potency", "definition" : "Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.", "comment" : "Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.", "min" : 0, "max" : "0", "base" : { "path" : "Immunization.isSubpotent", "min" : 0, "max" : "1" }, "type" : [{ "code" : "boolean" }], "meaningWhenMissing" : "By default, a dose should be considered to be potent.", "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : true, "isModifierReason" : "This element is labeled as a modifier because an immunization event with a subpotent vaccine doesn't protect the patient the same way as a potent dose.", "isSummary" : true, "mapping" : [{ "identity" : "v2", "map" : "RXA-20 = PA (partial administration)" }, { "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.subpotentReason", "path" : "Immunization.subpotentReason", "short" : "Reason for being subpotent", "definition" : "Reason why a dose is considered to be subpotent.", "min" : 0, "max" : "0", "base" : { "path" : "Immunization.subpotentReason", "min" : 0, "max" : "*" }, "type" : [{ "code" : "CodeableConcept" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "SubpotentReason" }], "strength" : "example", "description" : "The reason why a dose is considered to be subpotent.", "valueSet" : "http://hl7.org/fhir/ValueSet/immunization-subpotent-reason|4.0.1" }, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.education", "path" : "Immunization.education", "short" : "Educational material presented to patient", "definition" : "Educational material presented to the patient (or guardian) at the time of vaccine administration.", "min" : 0, "max" : "0", "base" : { "path" : "Immunization.education", "min" : 0, "max" : "*" }, "type" : [{ "code" : "BackboneElement" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "imm-1", "severity" : "error", "human" : "One of documentType or reference SHALL be present", "expression" : "documentType.exists() or reference.exists()", "xpath" : "exists(f:documentType) or exists(f:reference)", "source" : "http://hl7.org/fhir/StructureDefinition/Immunization" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.education.id", "path" : "Immunization.education.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "string" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.education.extension", "path" : "Immunization.education.extension", "short" : "Additional content defined by implementations", "definition" : "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.education.modifierExtension", "path" : "Immunization.education.modifierExtension", "short" : "Extensions that cannot be ignored even if unrecognized", "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "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.", "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias" : ["extensions", "user content", "modifiers"], "min" : 0, "max" : "*", "base" : { "path" : "BackboneElement.modifierExtension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : true, "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary" : true, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.education.documentType", "path" : "Immunization.education.documentType", "short" : "Educational material document identifier", "definition" : "Identifier of the material presented to the patient.", "min" : 0, "max" : "1", "base" : { "path" : "Immunization.education.documentType", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "v2", "map" : "OBX-5 : OBX-3 = 69764-9" }, { "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.education.reference", "path" : "Immunization.education.reference", "short" : "Educational material reference pointer", "definition" : "Reference pointer to the educational material given to the patient if the information was on line.", "min" : 0, "max" : "1", "base" : { "path" : "Immunization.education.reference", "min" : 0, "max" : "1" }, "type" : [{ "code" : "uri" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.education.publicationDate", "path" : "Immunization.education.publicationDate", "short" : "Educational material publication date", "definition" : "Date the educational material was published.", "min" : 0, "max" : "1", "base" : { "path" : "Immunization.education.publicationDate", "min" : 0, "max" : "1" }, "type" : [{ "code" : "dateTime" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "v2", "map" : "OBX-5 : OBX-3 = 29768-9" }, { "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.education.presentationDate", "path" : "Immunization.education.presentationDate", "short" : "Educational material presentation date", "definition" : "Date the educational material was given to the patient.", "min" : 0, "max" : "1", "base" : { "path" : "Immunization.education.presentationDate", "min" : 0, "max" : "1" }, "type" : [{ "code" : "dateTime" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "v2", "map" : "OBX-5 : OBX-3 = 29769-7" }, { "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.programEligibility", "path" : "Immunization.programEligibility", "short" : "Patient eligibility for a vaccination program", "definition" : "Indicates a patient's eligibility for a funding program.", "min" : 0, "max" : "0", "base" : { "path" : "Immunization.programEligibility", "min" : 0, "max" : "*" }, "type" : [{ "code" : "CodeableConcept" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "ProgramEligibility" }], "strength" : "example", "description" : "The patient's eligibility for a vaccation program.", "valueSet" : "http://hl7.org/fhir/ValueSet/immunization-program-eligibility|4.0.1" }, "mapping" : [{ "identity" : "v2", "map" : "OBX-5 : OBX-3 = 64994-7" }, { "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.fundingSource", "path" : "Immunization.fundingSource", "short" : "Funding source for the vaccine", "definition" : "Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).", "min" : 0, "max" : "0", "base" : { "path" : "Immunization.fundingSource", "min" : 0, "max" : "1" }, "type" : [{ "code" : "CodeableConcept" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "FundingSource" }], "strength" : "example", "description" : "The source of funding used to purchase the vaccine administered.", "valueSet" : "http://hl7.org/fhir/ValueSet/immunization-funding-source|4.0.1" }, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.reaction", "path" : "Immunization.reaction", "short" : "Details of a reaction that follows immunization", "definition" : "Categorical data indicating that an adverse event is associated in time to an immunization.", "comment" : "A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.", "min" : 0, "max" : "0", "base" : { "path" : "Immunization.reaction", "min" : 0, "max" : "*" }, "type" : [{ "code" : "BackboneElement" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "v2", "map" : "OBX-3" }, { "identity" : "rim", "map" : "Observation[classCode=obs].code" }] }, { "id" : "Immunization.reaction.id", "path" : "Immunization.reaction.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "string" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.reaction.extension", "path" : "Immunization.reaction.extension", "short" : "Additional content defined by implementations", "definition" : "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.reaction.modifierExtension", "path" : "Immunization.reaction.modifierExtension", "short" : "Extensions that cannot be ignored even if unrecognized", "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "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.", "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias" : ["extensions", "user content", "modifiers"], "min" : 0, "max" : "*", "base" : { "path" : "BackboneElement.modifierExtension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : true, "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary" : true, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.reaction.date", "path" : "Immunization.reaction.date", "short" : "When reaction started", "definition" : "Date of reaction to the immunization.", "min" : 0, "max" : "1", "base" : { "path" : "Immunization.reaction.date", "min" : 0, "max" : "1" }, "type" : [{ "code" : "dateTime" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "v2", "map" : "OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the HL7 v2 VXU message - most likely would appear in OBX segments if at all)" }, { "identity" : "rim", "map" : ".effectiveTime" }] }, { "id" : "Immunization.reaction.detail", "path" : "Immunization.reaction.detail", "short" : "Additional information on reaction", "definition" : "Details of the reaction.", "min" : 0, "max" : "1", "base" : { "path" : "Immunization.reaction.detail", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Observation|4.0.1"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "v2", "map" : "OBX-5" }, { "identity" : "rim", "map" : ".value" }] }, { "id" : "Immunization.reaction.reported", "path" : "Immunization.reaction.reported", "short" : "Indicates self-reported reaction", "definition" : "Self-reported indicator.", "min" : 0, "max" : "1", "base" : { "path" : "Immunization.reaction.reported", "min" : 0, "max" : "1" }, "type" : [{ "code" : "boolean" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "v2", "map" : "(HL7 v2 doesn't seem to provide for this)" }, { "identity" : "rim", "map" : ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)" }] }, { "id" : "Immunization.protocolApplied", "path" : "Immunization.protocolApplied", "short" : "Protocol followed by the provider", "definition" : "The protocol (set of recommendations) being followed by the provider who administered the dose.", "min" : 0, "max" : "1", "base" : { "path" : "Immunization.protocolApplied", "min" : 0, "max" : "*" }, "type" : [{ "code" : "BackboneElement" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.protocolApplied.id", "path" : "Immunization.protocolApplied.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "string" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.protocolApplied.extension", "path" : "Immunization.protocolApplied.extension", "short" : "Additional content defined by implementations", "definition" : "May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Immunization.protocolApplied.modifierExtension", "path" : "Immunization.protocolApplied.modifierExtension", "short" : "Extensions that cannot be ignored even if unrecognized", "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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "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.", "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "alias" : ["extensions", "user content", "modifiers"], "min" : 0, "max" : "*", "base" : { "path" : "BackboneElement.modifierExtension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : true, "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary" : true, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.protocolApplied.series", "path" : "Immunization.protocolApplied.series", "short" : "Name of vaccine series", "definition" : "One possible path to achieve presumed immunity against a disease - within the context of an authority.", "min" : 0, "max" : "1", "base" : { "path" : "Immunization.protocolApplied.series", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.protocolApplied.authority", "path" : "Immunization.protocolApplied.authority", "short" : "Who is responsible for publishing the recommendations", "definition" : "Indicates the authority who published the protocol (e.g. ACIP) that is being followed.", "min" : 0, "max" : "1", "base" : { "path" : "Immunization.protocolApplied.authority", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Organization|4.0.1"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.protocolApplied.targetDisease", "path" : "Immunization.protocolApplied.targetDisease", "short" : "Vaccine preventatable disease being targetted", "definition" : "The vaccine preventable disease the dose is being administered against.", "min" : 0, "max" : "*", "base" : { "path" : "Immunization.protocolApplied.targetDisease", "min" : 0, "max" : "*" }, "type" : [{ "code" : "CodeableConcept" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "TargetDisease" }], "strength" : "example", "description" : "The vaccine preventable disease the dose is being administered for.", "valueSet" : "http://hl7.org/fhir/ValueSet/immunization-target-disease|4.0.1" }, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.protocolApplied.doseNumber[x]", "path" : "Immunization.protocolApplied.doseNumber[x]", "short" : "Dose number within series", "definition" : "Nominal position in a series.", "comment" : "The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).", "min" : 1, "max" : "1", "base" : { "path" : "Immunization.protocolApplied.doseNumber[x]", "min" : 1, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Immunization.protocolApplied.seriesDoses[x]", "path" : "Immunization.protocolApplied.seriesDoses[x]", "short" : "Recommended number of doses for immunity", "definition" : "The recommended number of doses to achieve immunity.", "comment" : "The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).", "min" : 0, "max" : "1", "base" : { "path" : "Immunization.protocolApplied.seriesDoses[x]", "min" : 0, "max" : "1" }, "type" : [{ "code" : "positiveInt" }, { "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }] }, "differential" : { "element" : [{ "id" : "Immunization", "path" : "Immunization", "constraint" : [{ "key" : "nz-status-reason-1", "severity" : "error", "human" : "If the status reason has a system, then it must have a code.", "expression" : "statusReason.coding.system.exists() implies statusReason.coding.code.exists()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }, { "key" : "nz-status-reason-2", "severity" : "error", "human" : "If the status reason has a code, then it must have a system.", "expression" : "statusReason.coding.code.exists() implies statusReason.coding.system.exists()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }, { "key" : "nz-site-1", "severity" : "error", "human" : "If the body site has a system, then it must have a code.", "expression" : "site.coding.system.exists() implies site.coding.code.exists()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }, { "key" : "nz-site-2", "severity" : "error", "human" : "If the body site has a code, then it must have a system.", "expression" : "site.coding.code.exists() implies site.coding.system.exists()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }, { "key" : "nz-route-1", "severity" : "error", "human" : "If the route of admin has a system, then it must have a code.", "expression" : "route.coding.system.exists() implies route.coding.code.exists()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }, { "key" : "nz-route-2", "severity" : "error", "human" : "if the route of admin has a code, then it must have a system.", "expression" : "route.coding.code.exists() implies route.coding.system.exists()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }, { "key" : "nz-performer-function-1", "severity" : "error", "human" : "If the performer function has a system, then it must have a code.", "expression" : "performer.function.coding.system.exists() implies performer.function.coding.code.exists()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }, { "key" : "nz-performer-function-2", "severity" : "error", "human" : "If the performer function has a code, then it must have a system.", "expression" : "performer.function.coding.code.exists() implies performer.function.coding.system.exists()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }, { "key" : "nz-reasonCode-1", "severity" : "error", "human" : "If the reasonCode aka indication has a system, then it must have a code.", "expression" : "reasonCode.coding.system.exists() implies reasonCode.coding.code.exists()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }, { "key" : "nz-reasonCode-2", "severity" : "error", "human" : "If the reasonCode aka indication has a code, then it must have a system.", "expression" : "reasonCode.coding.code.exists() implies reasonCode.coding.system.exists()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }, { "key" : "air-resched-1", "severity" : "error", "human" : "Only allow a reschedule date if status NOT DONE and statusReason related to rescheduling.", "expression" : "extension.where(url = 'https://standards.digital.health.nz/fhir/air/StructureDefinition/air-reschedule-date').exists() implies status.value = 'not-done' and statusReason.coding.where(code = 'RESCHO' | 'RESREF' | 'RESTC').allTrue()", "source" : "https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization" }] }, { "id" : "Immunization.meta.extension:DataQualityAssessment", "path" : "Immunization.meta.extension", "sliceName" : "DataQualityAssessment", "min" : 0, "max" : "1", "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-data-quality-assessment"] }] }, { "id" : "Immunization.meta.extension:PlannedEventMatch", "path" : "Immunization.meta.extension", "sliceName" : "PlannedEventMatch", "min" : 0, "max" : "*", "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match"] }] }, { "id" : "Immunization.meta.extension:PlannedEventMatchQuality", "path" : "Immunization.meta.extension", "sliceName" : "PlannedEventMatchQuality", "min" : 0, "max" : "*", "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-planned-event-match-quality"] }] }, { "id" : "Immunization.meta.extension:CreatedSourceSystem", "path" : "Immunization.meta.extension", "sliceName" : "CreatedSourceSystem", "min" : 0, "max" : "1", "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-created-source-system"] }] }, { "id" : "Immunization.meta.extension:CreatedBy", "path" : "Immunization.meta.extension", "sliceName" : "CreatedBy", "min" : 0, "max" : "1", "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-created-by"] }] }, { "id" : "Immunization.meta.extension:ModifiedSourceSystem", "path" : "Immunization.meta.extension", "sliceName" : "ModifiedSourceSystem", "min" : 0, "max" : "1", "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-source-system"] }] }, { "id" : "Immunization.meta.extension:ModifiedBy", "path" : "Immunization.meta.extension", "sliceName" : "ModifiedBy", "min" : 0, "max" : "1", "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-modified-by"] }] }, { "id" : "Immunization.meta.extension:CreatedDate", "path" : "Immunization.meta.extension", "sliceName" : "CreatedDate", "min" : 0, "max" : "1", "type" : [{ "code" : "Extension", "profile" : ["http://hl7.org/fhir/StructureDefinition/firstCreated"] }] }, { "id" : "Immunization.extension", "path" : "Immunization.extension", "slicing" : { "discriminator" : [{ "type" : "value", "path" : "url" }], "ordered" : false, "rules" : "open" } }, { "id" : "Immunization.extension:administeredProduct", "path" : "Immunization.extension", "sliceName" : "administeredProduct", "min" : 0, "max" : "1", "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-administered-product"] }] }, { "id" : "Immunization.extension:Diluent", "path" : "Immunization.extension", "sliceName" : "Diluent", "min" : 0, "max" : "1", "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-diluent"] }] }, { "id" : "Immunization.extension:MobileSiteId", "path" : "Immunization.extension", "sliceName" : "MobileSiteId", "min" : 0, "max" : "1", "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-mobile-site"] }] }, { "id" : "Immunization.extension:AgeGiven", "path" : "Immunization.extension", "sliceName" : "AgeGiven", "min" : 0, "max" : "1", "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-age-given"] }] }, { "id" : "Immunization.extension:relatedPersonExtension", "path" : "Immunization.extension", "sliceName" : "relatedPersonExtension", "min" : 0, "max" : "*", "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-related-person-extension"] }] }, { "id" : "Immunization.extension:serologyReportExtension", "path" : "Immunization.extension", "sliceName" : "serologyReportExtension", "min" : 0, "max" : "1", "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-serology-report-extension"] }] }, { "id" : "Immunization.extension:rescheduleDateExtension", "path" : "Immunization.extension", "sliceName" : "rescheduleDateExtension", "min" : 0, "max" : "*", "type" : [{ "code" : "Extension", "profile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-reschedule-date"] }] }, { "id" : "Immunization.statusReason", "path" : "Immunization.statusReason", "definition" : "The status reason codes CIS and CPI are included in the Status Reason Code System for backward compatibility, but use of these codes for new events is deprecated.", "binding" : { "strength" : "preferred", "valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/air-status-reason-code" } }, { "id" : "Immunization.statusReason.coding", "path" : "Immunization.statusReason.coding", "min" : 1, "max" : "1" }, { "id" : "Immunization.vaccineCode", "path" : "Immunization.vaccineCode", "binding" : { "strength" : "preferred", "valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/air-vaccine-product-code" } }, { "id" : "Immunization.vaccineCode.coding", "path" : "Immunization.vaccineCode.coding", "min" : 1, "max" : "1" }, { "id" : "Immunization.vaccineCode.coding.system", "path" : "Immunization.vaccineCode.coding.system", "min" : 1 }, { "id" : "Immunization.vaccineCode.coding.code", "path" : "Immunization.vaccineCode.coding.code", "min" : 1 }, { "id" : "Immunization.patient", "path" : "Immunization.patient", "definition" : "The patient should be sent using the logical reference format, specifically an identifier with a system and a value. The identifier must be the NZ NHI number." }, { "id" : "Immunization.encounter", "path" : "Immunization.encounter", "max" : "0" }, { "id" : "Immunization.occurrence[x]", "path" : "Immunization.occurrence[x]", "type" : [{ "code" : "dateTime" }] }, { "id" : "Immunization.primarySource", "path" : "Immunization.primarySource", "max" : "0" }, { "id" : "Immunization.reportOrigin", "path" : "Immunization.reportOrigin", "max" : "0" }, { "id" : "Immunization.location", "path" : "Immunization.location", "short" : "The location where the immunisation was administered.", "definition" : "The location should be sent using the logical reference format, specifically an identifier with a system and a value. The required identification system is the HPI-F. See the HPI Implementation Guide at https://hpi-ig.hip.digital.health.nz/index.html. ", "type" : [{ "code" : "Reference", "targetProfile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-location"] }] }, { "id" : "Immunization.manufacturer", "path" : "Immunization.manufacturer", "max" : "0" }, { "id" : "Immunization.site", "path" : "Immunization.site", "short" : "The body site of the vaccine administration (SNOMED code).", "binding" : { "strength" : "preferred", "valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/air-site-code" } }, { "id" : "Immunization.site.coding", "path" : "Immunization.site.coding", "min" : 1, "max" : "1" }, { "id" : "Immunization.route", "path" : "Immunization.route", "short" : "The route of administation of the vaccine.", "binding" : { "strength" : "preferred", "valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/air-route-code" } }, { "id" : "Immunization.route.coding", "path" : "Immunization.route.coding", "min" : 1, "max" : "1" }, { "id" : "Immunization.doseQuantity", "path" : "Immunization.doseQuantity", "max" : "0" }, { "id" : "Immunization.performer.function", "path" : "Immunization.performer.function", "binding" : { "strength" : "extensible", "valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/air-performer-health-worker-function-code" } }, { "id" : "Immunization.performer.function.coding", "path" : "Immunization.performer.function.coding", "min" : 1, "max" : "1" }, { "id" : "Immunization.performer.actor", "path" : "Immunization.performer.actor", "type" : [{ "code" : "Reference", "targetProfile" : ["https://standards.digital.health.nz/fhir/air/StructureDefinition/air-practitioner"] }] }, { "id" : "Immunization.note", "path" : "Immunization.note", "max" : "0" }, { "id" : "Immunization.reasonCode", "path" : "Immunization.reasonCode", "binding" : { "strength" : "preferred", "valueSet" : "https://nzhts.digital.health.nz/fhir/ValueSet/air-indication-code" } }, { "id" : "Immunization.isSubpotent", "path" : "Immunization.isSubpotent", "max" : "0" }, { "id" : "Immunization.subpotentReason", "path" : "Immunization.subpotentReason", "max" : "0" }, { "id" : "Immunization.education", "path" : "Immunization.education", "max" : "0" }, { "id" : "Immunization.programEligibility", "path" : "Immunization.programEligibility", "max" : "0" }, { "id" : "Immunization.fundingSource", "path" : "Immunization.fundingSource", "max" : "0" }, { "id" : "Immunization.reaction", "path" : "Immunization.reaction", "max" : "0" }, { "id" : "Immunization.protocolApplied", "path" : "Immunization.protocolApplied", "max" : "1" }, { "id" : "Immunization.protocolApplied.doseNumber[x]", "path" : "Immunization.protocolApplied.doseNumber[x]", "type" : [{ "code" : "string" }] }] } }