{
"description": "Vaccinatie (Immunization)",
"_filename": "StructureDefinition-Immunization.json",
"package_name": "hl7.fhir.nl.zorgviewer",
"date": "2025-04-01T10:39:46+00:00",
"derivation": "constraint",
"publisher": "RIVO-NN HL7NL",
"fhirVersion": "3.0.2",
"jurisdiction": [ {
"coding": [ {
"code": "NL",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "Vaccination",
"mapping": [ {
"uri": "https://zibs.nl/wiki/Vaccination-v3.1(2017EN)",
"name": "HCIM Vaccination-v3.1(2017EN)",
"identity": "hcim-vaccination-v3.1-2017EN"
}, {
"uri": "https://zibs.nl/wiki/HealthProfessional-v3.2(2017EN)",
"name": "HCIM HealthProfessional-v3.2(2017EN)",
"identity": "hcim-healthprofessional-v3.2-2017EN"
}, {
"uri": "https://zibs.nl/wiki/BasicElements-v1.0(2017EN)",
"name": "HCIM BasicElements-v1.0(2017EN)",
"identity": "hcim-basicelements-v1.0-2017EN"
}, {
"uri": "https://zibs.nl/wiki/Vaccination-v3.0(2016EN)",
"name": "HCIM Vaccination-v3.0(2016EN)",
"identity": "hcim-vaccination-v3.0-2016EN"
}, {
"uri": "https://zibs.nl/wiki/HealthProfessional-v3.0(2016EN)",
"name": "HCIM HealthProfessional-v3.0(2016EN)",
"identity": "hcim-healthprofessional-v3.0-2016EN"
}, {
"uri": "https://zibs.nl/wiki/Vaccination-v1.2(2015EN)",
"name": "HCIM Vaccination-v1.2(2015EN)",
"identity": "hcim-vaccination-v1.2-2015EN"
}, {
"uri": "https://zibs.nl/wiki/HealthProfessional-v1.2.1(2015EN)",
"name": "HCIM HealthProfessional-v1.2.1(2015EN)",
"identity": "hcim-healthprofessional-v1.2.1-2015EN"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Mapping",
"identity": "workflow"
}, {
"uri": "http://hl7.org/v3/cda",
"name": "CDA (R2)",
"identity": "cda"
} ],
"abstract": false,
"type": "Immunization",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "Vaccination",
"package_version": "1.13.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
}, {
"key": "imm-2",
"human": "If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.",
"xpath": "not(f:notGiven/@value=false() and exists(f:explanation/f:reasonNotGiven))",
"source": "http://hl7.org/fhir/StructureDefinition/Immunization",
"severity": "error",
"expression": "(notGiven = true) or explanation.reasonNotGiven.empty()"
}, {
"key": "imm-1",
"human": "If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present",
"xpath": "not(f:notGiven/@value=true() and (count(f:reaction) > 0 or exists(f:explanation/f:reason)))",
"source": "http://hl7.org/fhir/StructureDefinition/Immunization",
"severity": "error",
"expression": "(notGiven = true).not() or (reaction.empty() and explanation.reason.empty())"
} ],
"path": "Immunization",
"min": 0,
"definition": "Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.",
"short": "Vaccination",
"mapping": [ {
"map": "NL-CM:11.1.1",
"comment": "Vaccination",
"identity": "hcim-vaccination-v1.2-2015EN"
}, {
"map": "NL-CM:11.1.1",
"comment": "Vaccination",
"identity": "hcim-vaccination-v3.0-2016EN"
}, {
"map": "NL-CM:11.1.1",
"comment": "Vaccination",
"identity": "hcim-vaccination-v3.1-2017EN"
}, {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "VXU_V04",
"identity": "v2"
}, {
"map": "SubstanceAdministration",
"identity": "rim"
}, {
"map": "clinical.medication",
"identity": "w5"
} ],
"alias": [ "Vaccinatie" ],
"max": "*",
"id": "Immunization",
"base": {
"max": "*",
"min": 0,
"path": "Immunization"
}
}, {
"path": "Immunization.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"short": "Logical id of this artifact",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Immunization.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "Immunization.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Immunization.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Immunization.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Immunization.implicitRules",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "Immunization.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Immunization.language",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "Immunization.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Immunization.text",
"condition": [ "dom-1" ],
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "Immunization.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Immunization.contained",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "Immunization.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "Immunization.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "Immunization.identifier",
"min": 0,
"definition": "A unique identifier assigned to this immunization record.",
"short": "Business identifier",
"mapping": [ {
"map": "NL-CM:0.0.6",
"comment": "IdentificationNumber",
"identity": "hcim-basicelements-v1.0-2017EN"
}, {
"map": "Event.identifier",
"identity": "workflow"
}, {
"map": ".id",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id",
"identity": "cda"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "Immunization.identifier",
"base": {
"max": "*",
"min": 0,
"path": "Immunization.identifier"
}
}, {
"path": "Immunization.status",
"min": 1,
"definition": "Indicates the current status of the vaccination event.",
"isModifier": true,
"short": "completed | entered-in-error",
"mapping": [ {
"map": "Event.status",
"identity": "workflow"
}, {
"map": "statusCode",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationStatus"
} ],
"description": "A set of codes indicating the current status of an Immunization",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-status"
}
},
"max": "1",
"id": "Immunization.status",
"comment": "Will generally be set to show that the immunization has been completed.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.status"
},
"isSummary": true
}, {
"path": "Immunization.notGiven",
"min": 1,
"definition": "Indicates if the vaccination was or was not given.",
"isModifier": true,
"short": "Flag for whether immunization was given",
"mapping": [ {
"map": "Event.notDone",
"identity": "workflow"
}, {
"map": "[actionNegationInd=true].reasonCode",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.notGiven",
"comment": "This element is labeled as a modifier because it indicates that an immunization didn't happen.",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.notGiven"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode",
"min": 1,
"definition": "The product code of the vaccine administered.\r\nThere are several possible code systems for documenting the product code. If the vaccination data is registered based on an anamnesis, coding with the ATC code is preferred. In all cases it concerns those products that fall under ATC group J07 (vaccines).",
"short": "ProductCode",
"mapping": [ {
"map": "NL-CM:11.1.2",
"comment": "ProductCode",
"identity": "hcim-vaccination-v1.2-2015EN"
}, {
"map": "NL-CM:11.1.2",
"comment": "ProductCode",
"identity": "hcim-vaccination-v3.0-2016EN"
}, {
"map": "NL-CM:11.1.2",
"comment": "ProductCode",
"identity": "hcim-vaccination-v3.1-2017EN"
}, {
"map": "Event.code",
"identity": "workflow"
}, {
"map": "RXA-5",
"identity": "v2"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code",
"identity": "cda"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccineCode"
} ],
"description": "The code for vaccine product administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/vaccine-code"
}
},
"alias": [ "ProductCode" ],
"max": "1",
"id": "Immunization.vaccineCode",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.vaccineCode"
}
}, {
"path": "Immunization.vaccineCode.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccineCode.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.vaccineCode.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccineCode.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.vaccineCode.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 1,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "system",
"type": "value"
} ]
},
"type": [ {
"code": "Coding"
} ],
"max": "*",
"id": "Immunization.vaccineCode.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccineCode.coding.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.vaccineCode.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccineCode.coding.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.vaccineCode.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 0,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding.system",
"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 de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.version",
"min": 0,
"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.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding.version",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"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).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.userSelected",
"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,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"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 ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding.userSelected",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "productCodeGPKCodelijst",
"binding": {
"strength": "required",
"description": "ProductCodeGPKCodelijst",
"valueSetReference": {
"reference": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.3--20171231000000"
}
},
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeGPKCodelijst",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeGPKCodelijst.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.vaccineCode.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccineCode.coding:productCodeGPKCodelijst.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.vaccineCode.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"fixedUri": "urn:oid:2.16.840.1.113883.2.4.4.1",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeGPKCodelijst.system",
"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 de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.version",
"min": 0,
"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.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeGPKCodelijst.version",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"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).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeGPKCodelijst.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeGPKCodelijst.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.userSelected",
"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,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"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 ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeGPKCodelijst.userSelected",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "productCodeHPKCodelijst",
"binding": {
"strength": "required",
"description": "ProductCodeHPKCodelijst",
"valueSetReference": {
"reference": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.2--20171231000000"
}
},
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeHPKCodelijst",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeHPKCodelijst.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.vaccineCode.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccineCode.coding:productCodeHPKCodelijst.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.vaccineCode.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"fixedUri": "urn:oid:2.16.840.1.113883.2.4.4.7",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeHPKCodelijst.system",
"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 de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.version",
"min": 0,
"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.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeHPKCodelijst.version",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"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).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeHPKCodelijst.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeHPKCodelijst.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.userSelected",
"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,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"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 ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeHPKCodelijst.userSelected",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "productCodeZICodelijst",
"binding": {
"strength": "required",
"description": "ProductCodeZICodelijst",
"valueSetReference": {
"reference": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.6--20171231000000"
}
},
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeZICodelijst",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeZICodelijst.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.vaccineCode.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccineCode.coding:productCodeZICodelijst.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.vaccineCode.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"fixedUri": "urn:oid:2.16.840.1.113883.2.4.4.8",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeZICodelijst.system",
"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 de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.version",
"min": 0,
"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.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeZICodelijst.version",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"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).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeZICodelijst.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeZICodelijst.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.userSelected",
"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,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"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 ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeZICodelijst.userSelected",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "productCodeATCCodelijst",
"binding": {
"strength": "required",
"description": "ProductCodeATCCodelijst",
"valueSetReference": {
"reference": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.4--20171231000000"
}
},
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeATCCodelijst",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeATCCodelijst.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.vaccineCode.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccineCode.coding:productCodeATCCodelijst.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.vaccineCode.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"fixedUri": "http://www.whocc.no/atc",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeATCCodelijst.system",
"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 de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.version",
"min": 0,
"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.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeATCCodelijst.version",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"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).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeATCCodelijst.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeATCCodelijst.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.userSelected",
"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,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"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 ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeATCCodelijst.userSelected",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "productCodePRKCodelijst",
"binding": {
"strength": "required",
"description": "ProductCodePRKCodelijst",
"valueSetReference": {
"reference": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.1--20171231000000"
}
},
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodePRKCodelijst",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodePRKCodelijst.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.vaccineCode.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccineCode.coding:productCodePRKCodelijst.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.vaccineCode.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"fixedUri": "urn:oid:2.16.840.1.113883.2.4.4.10",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodePRKCodelijst.system",
"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 de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.version",
"min": 0,
"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.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodePRKCodelijst.version",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"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).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodePRKCodelijst.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodePRKCodelijst.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.userSelected",
"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,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"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 ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodePRKCodelijst.userSelected",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "productCodeGTINCodelijst",
"binding": {
"strength": "required",
"description": "ProductCodeGTINCodelijst",
"valueSetReference": {
"reference": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.11.1.5--20171231000000"
}
},
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeGTINCodelijst",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeGTINCodelijst.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.vaccineCode.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccineCode.coding:productCodeGTINCodelijst.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.vaccineCode.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"fixedUri": "urn:oid:1.3.160",
"mapping": [ {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeGTINCodelijst.system",
"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 de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.version",
"min": 0,
"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.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeGTINCodelijst.version",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 0,
"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).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeGTINCodelijst.code",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeGTINCodelijst.display",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.coding.userSelected",
"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,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"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 ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding:productCodeGTINCodelijst.userSelected",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"path": "Immunization.vaccineCode.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.vaccineCode.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "Immunization.patient",
"min": 1,
"definition": "The patient who either received or did not receive the immunization.",
"short": "Who was immunized",
"mapping": [ {
"map": "NL-CM:0.0.11",
"comment": "Subject",
"identity": "hcim-basicelements-v1.0-2017EN"
}, {
"map": "Event.subject",
"identity": "workflow"
}, {
"map": "PID-3",
"identity": "v2"
}, {
"map": ".partipication[ttypeCode=].role",
"identity": "rim"
}, {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://fhir.nl/fhir/StructureDefinition/nl-core-patient"
} ],
"max": "1",
"id": "Immunization.patient",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.patient"
}
}, {
"path": "Immunization.encounter",
"min": 0,
"definition": "The visit or admission or other contact between patient and health care provider the immunization was performed as part of.",
"short": "Encounter administered as part of",
"mapping": [ {
"map": "Event.context",
"identity": "workflow"
}, {
"map": "PV1-19",
"identity": "v2"
}, {
"map": "component->EncounterEvent",
"identity": "rim"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://nictiz.nl/fhir/StructureDefinition/zib-Encounter"
} ],
"max": "1",
"id": "Immunization.encounter",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.encounter"
}
}, {
"path": "Immunization.date",
"min": 1,
"definition": "Date (and if possible time) that the vaccine was administered.",
"short": "VaccinationDate",
"mapping": [ {
"map": "NL-CM:11.1.3",
"comment": "VaccinationDate",
"identity": "hcim-vaccination-v1.2-2015EN"
}, {
"map": "NL-CM:11.1.3",
"comment": "VaccinationDate",
"identity": "hcim-vaccination-v3.0-2016EN"
}, {
"map": "NL-CM:11.1.3",
"comment": "VaccinationDate",
"identity": "hcim-vaccination-v3.1-2017EN"
}, {
"map": "NL-CM:0.0.14",
"comment": "DateTime",
"identity": "hcim-basicelements-v1.0-2017EN"
}, {
"map": "Event.occurrence.occurrenceDateTime",
"identity": "workflow"
}, {
"map": "RXA-3",
"identity": "v2"
}, {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value",
"identity": "cda"
}, {
"map": "when.init",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": true,
"alias": [ "VaccinatieDatum" ],
"max": "1",
"id": "Immunization.date",
"comment": "When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given.",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.date"
}
}, {
"path": "Immunization.primarySource",
"min": 1,
"definition": "An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.",
"short": "Indicates context the data was recorded in",
"mapping": [ {
"map": "RXA-9",
"identity": "v2"
}, {
"map": "immunization.uncertaintycode (if primary source=false, uncertainty=U)",
"identity": "rim"
}, {
"map": "who.source",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.primarySource",
"comment": "Reflects the “reliability” of the content.",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.primarySource"
}
}, {
"path": "Immunization.reportOrigin",
"min": 0,
"definition": "The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.",
"short": "Indicates the source of a secondarily reported record",
"mapping": [ {
"map": "NL-CM:0.0.2",
"comment": "InformationSource",
"identity": "hcim-basicelements-v1.0-2017EN"
}, {
"map": "RXA-9",
"identity": "v2"
}, {
"map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported)\n.participation[typeCode=INF].role[classCode=LIC] (this syntax for health care professional)\n.participation[typeCode=INF].role[classCode=PRS] (this syntax for family member)",
"identity": "rim"
}, {
"map": "who.source",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationReportOrigin"
} ],
"description": "The source of the data for a record which is not from a primary source.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-origin"
}
},
"max": "1",
"id": "Immunization.reportOrigin",
"comment": "Should not be populated if primarySource = True, will not be required even if primarySource = False.",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.reportOrigin"
}
}, {
"path": "Immunization.location",
"min": 0,
"definition": "The service delivery location where the vaccine administration occurred.",
"short": "Where vaccination occurred",
"mapping": [ {
"map": "RXA-27 (or RXA-11, deprecated as of v2.7)",
"identity": "v2"
}, {
"map": ".participation[typeCode=LOC].COCT_MT240000UV",
"identity": "rim"
}, {
"map": "where",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://fhir.nl/fhir/StructureDefinition/nl-core-location"
} ],
"max": "1",
"id": "Immunization.location",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.location"
}
}, {
"path": "Immunization.manufacturer",
"min": 0,
"definition": "Name of vaccine manufacturer.",
"short": "Vaccine manufacturer",
"mapping": [ {
"map": "RXA-17",
"identity": "v2"
}, {
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://fhir.nl/fhir/StructureDefinition/nl-core-organization"
} ],
"max": "1",
"id": "Immunization.manufacturer",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.manufacturer"
}
}, {
"path": "Immunization.lotNumber",
"min": 0,
"definition": "Lot number of the vaccine product.",
"short": "Vaccine lot number",
"mapping": [ {
"map": "RXA-15",
"identity": "v2"
}, {
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText",
"identity": "cda"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.lotNumber",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.lotNumber"
}
}, {
"path": "Immunization.expirationDate",
"min": 0,
"definition": "Date vaccine batch expires.",
"short": "Vaccine expiration date",
"mapping": [ {
"map": "RXA-16",
"identity": "v2"
}, {
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime",
"identity": "rim"
} ],
"type": [ {
"code": "date"
} ],
"max": "1",
"id": "Immunization.expirationDate",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.expirationDate"
}
}, {
"path": "Immunization.site",
"min": 0,
"definition": "Body site where vaccine was administered.",
"short": "Body site vaccine was administered",
"mapping": [ {
"map": "RXR-2",
"identity": "v2"
}, {
"map": "observation.targetSiteCode",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationSite"
} ],
"description": "The site at which the vaccine was administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-site"
}
},
"max": "1",
"id": "Immunization.site",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.site"
}
}, {
"path": "Immunization.route",
"min": 0,
"definition": "The path by which the vaccine product is taken into the body.",
"short": "How vaccine entered body",
"mapping": [ {
"map": "RXR-1",
"identity": "v2"
}, {
"map": ".routeCode",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationRoute"
} ],
"description": "The route by which the vaccine was administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-route"
}
},
"max": "1",
"id": "Immunization.route",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.route"
}
}, {
"path": "Immunization.doseQuantity",
"min": 0,
"definition": "The amount of product administered shown in milliliters. In most cases, the entire product is administered; in some cases, a described part of the product is administered.",
"short": "Dose",
"mapping": [ {
"map": "NL-CM:11.1.4",
"comment": "Dose",
"identity": "hcim-vaccination-v1.2-2015EN"
}, {
"map": "NL-CM:11.1.4",
"comment": "Dose",
"identity": "hcim-vaccination-v3.0-2016EN"
}, {
"map": "NL-CM:11.1.4",
"comment": "Dose",
"identity": "hcim-vaccination-v3.1-2017EN"
}, {
"map": "RXA-6 / RXA-7.1",
"identity": "v2"
}, {
"map": ".doseQuantity",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
} ],
"alias": [ "Dosis" ],
"max": "1",
"id": "Immunization.doseQuantity",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.doseQuantity"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.practitioner",
"min": 0,
"definition": "Indicates who or what performed the event.",
"short": "Who performed event",
"mapping": [ {
"map": "NL-CM:0.0.7",
"comment": "Author",
"identity": "hcim-basicelements-v1.0-2017EN"
}, {
"map": "Event.performer",
"identity": "workflow"
}, {
"map": "ORC-12 / RXA-10",
"identity": "v2"
}, {
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "Immunization.practitioner",
"base": {
"max": "*",
"min": 0,
"path": "Immunization.practitioner"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.practitioner.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.practitioner.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.practitioner.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.practitioner.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Immunization.practitioner.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.role",
"min": 0,
"definition": "Describes the type of performance (e.g. ordering provider, administering provider, etc.).",
"short": "What type of performance was done",
"mapping": [ {
"map": "Event.performer.role",
"identity": "workflow"
}, {
"map": ".participation.functionCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationRole"
} ],
"description": "The role a practitioner plays in the immunization event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-role"
}
},
"max": "1",
"id": "Immunization.practitioner.role",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.practitioner.role"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.role.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.practitioner.role.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.practitioner.role.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.practitioner.role.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.practitioner.role.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "$this",
"type": "value"
} ]
},
"type": [ {
"code": "Coding"
} ],
"max": "*",
"id": "Immunization.practitioner.role.coding",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.role.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "The role the healthcare provider fulfils in the healthcare process. For healthcare providers, this could be for example main practitioner, referrer or general practitioner.",
"short": "HealthProfessionalRole",
"mapping": [ {
"map": "NL-CM:17.1.5",
"comment": "HealthcareProviderRole",
"identity": "hcim-healthprofessional-v1.2.1-2015EN"
}, {
"map": "NL-CM:17.1.5",
"comment": "HealthcareProviderRole",
"identity": "hcim-healthprofessional-v3.0-2016EN"
}, {
"map": "NL-CM:17.1.5",
"comment": "HealthProfessionalRole",
"identity": "hcim-healthprofessional-v3.2-2017EN"
}, {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "healthProfessionalRole",
"binding": {
"strength": "required",
"valueSetReference": {
"reference": "http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20171231000000"
}
},
"alias": [ "ZorgverlenerRol" ],
"max": "*",
"id": "Immunization.practitioner.role.coding:healthProfessionalRole",
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.role.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.practitioner.role.text",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.actor",
"min": 1,
"definition": "The healthcare provider and/or organization where or by whom the immunization was done.",
"short": "Administrator",
"mapping": [ {
"map": "NL-CM:11.1.6",
"comment": "Administrator",
"identity": "hcim-vaccination-v1.2-2015EN"
}, {
"map": "NL-CM:11.1.6",
"comment": "Administrator",
"identity": "hcim-vaccination-v3.0-2016EN"
}, {
"map": "NL-CM:11.1.6",
"comment": "Administrator",
"identity": "hcim-vaccination-v3.1-2017EN"
}, {
"map": "Event.performer.actor",
"identity": "workflow"
}, {
"map": ".player",
"identity": "rim"
}, {
"map": "who.actor",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner"
} ],
"alias": [ "Toediener" ],
"max": "1",
"id": "Immunization.practitioner.actor",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.practitioner.actor"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.actor.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.practitioner.actor.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.practitioner.actor.extension",
"min": 0,
"definition": "An Extension",
"short": "Extension",
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "*",
"id": "Immunization.practitioner.actor.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.practitioner.actor.extension",
"min": 0,
"definition": "Optional Extension Element - found in all resources.",
"short": "Optional Extensions Element",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": "http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference"
} ],
"sliceName": "practitionerRole",
"max": "1",
"id": "Immunization.practitioner.actor.extension:practitionerRole",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.practitioner.actor.reference",
"min": 0,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.practitioner.actor.reference",
"condition": [ "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.actor.identifier",
"min": 0,
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "Immunization.practitioner.actor.identifier",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"path": "Immunization.practitioner.actor.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"short": "Text alternative for the resource",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.practitioner.actor.display",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"path": "Immunization.note",
"min": 0,
"definition": "Extra information about the immunization that is not conveyed by the other attributes.",
"short": "Vaccination notes",
"mapping": [ {
"map": "Event.note",
"identity": "workflow"
}, {
"map": "note",
"identity": "rim"
} ],
"type": [ {
"code": "Annotation"
} ],
"max": "*",
"id": "Immunization.note",
"base": {
"max": "*",
"min": 0,
"path": "Immunization.note"
},
"isSummary": true
}, {
"path": "Immunization.note.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.note.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.note.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.note.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.note.author[x]",
"min": 0,
"definition": "The individual responsible for making the annotation.",
"short": "Individual responsible for the annotation",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "Act.participant[typeCode=AUT].role",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}, {
"code": "string"
} ],
"max": "1",
"id": "Immunization.note.author[x]",
"base": {
"max": "1",
"min": 0,
"path": "Annotation.author[x]"
},
"isSummary": true
}, {
"path": "Immunization.note.time",
"min": 0,
"definition": "Indicates when this particular annotation was made.",
"short": "When the annotation was made",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "Act.effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Immunization.note.time",
"base": {
"max": "1",
"min": 0,
"path": "Annotation.time"
},
"isSummary": true
}, {
"path": "Immunization.note.text",
"min": 1,
"definition": "Free text explanation.\r\nExamples of commonly used explanations are: - \"Vaccination according to the National Immunisation Program\". - \"Not according to the National Immunisation Program\", followed by further explanation. - \"Unknown\"",
"short": "Comment",
"mapping": [ {
"map": "NL-CM:11.1.7",
"comment": "Explanation",
"identity": "hcim-vaccination-v1.2-2015EN"
}, {
"map": "NL-CM:11.1.7",
"comment": "Explanation",
"identity": "hcim-vaccination-v3.0-2016EN"
}, {
"map": "NL-CM:11.1.7",
"comment": "Comment",
"identity": "hcim-vaccination-v3.1-2017EN"
}, {
"map": "N/A",
"identity": "v2"
}, {
"map": "Act.text",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"alias": [ "Toelichting" ],
"max": "1",
"id": "Immunization.note.text",
"base": {
"max": "1",
"min": 1,
"path": "Annotation.text"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation",
"min": 0,
"definition": "Reasons why a vaccine was or was not administered.",
"short": "Administration/non-administration reasons",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "Immunization.explanation",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.explanation"
}
}, {
"path": "Immunization.explanation.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.explanation.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.explanation.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.explanation.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.explanation.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Immunization.explanation.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Immunization.explanation.reason",
"min": 0,
"definition": "Reasons why a vaccine was administered.",
"short": "Why immunization occurred",
"mapping": [ {
"map": "Event.reasonCodeableConcept",
"identity": "workflow"
}, {
"map": "[actionNegationInd=false].reasonCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationReason"
} ],
"description": "The reason why a vaccine was administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-reason"
}
},
"max": "*",
"id": "Immunization.explanation.reason",
"base": {
"max": "*",
"min": 0,
"path": "Immunization.explanation.reason"
}
}, {
"path": "Immunization.explanation.reasonNotGiven",
"min": 0,
"definition": "Reason why a vaccine was not administered.",
"short": "Why immunization did not occur",
"mapping": [ {
"map": "Event.notDoneReason",
"identity": "workflow"
}, {
"map": "RXA-18",
"identity": "v2"
}, {
"map": "[actionNegationInd=true].reasonCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NoImmunizationReason"
} ],
"description": "The reason why a vaccine was not administered",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/no-immunization-reason"
}
},
"max": "*",
"id": "Immunization.explanation.reasonNotGiven",
"base": {
"max": "*",
"min": 0,
"path": "Immunization.explanation.reasonNotGiven"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.reaction",
"min": 0,
"definition": "Categorical data indicating that an adverse event is associated in time to an immunization.",
"short": "Details of a reaction that follows immunization",
"mapping": [ {
"map": "OBX-3",
"identity": "v2"
}, {
"map": "Observation[classCode=obs].code",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "Immunization.reaction",
"comment": "A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new [AllergyIntolerance](http://hl7.org/fhir/STU3/allergyintolerance.html) resource instance as most systems will not query against past Immunization.reaction elements.",
"base": {
"max": "*",
"min": 0,
"path": "Immunization.reaction"
}
}, {
"path": "Immunization.reaction.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.reaction.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.reaction.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.reaction.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.reaction.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Immunization.reaction.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Immunization.reaction.date",
"min": 0,
"definition": "Date of reaction to the immunization.",
"short": "When reaction started",
"mapping": [ {
"map": "OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the HL7 v2 VXU message - most likely would appear in OBX segments if at all)",
"identity": "v2"
}, {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Immunization.reaction.date",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.reaction.date"
}
}, {
"path": "Immunization.reaction.detail",
"min": 0,
"definition": "Details of the reaction.",
"short": "Additional information on reaction",
"mapping": [ {
"map": "OBX-5",
"identity": "v2"
}, {
"map": ".value",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation"
} ],
"max": "1",
"id": "Immunization.reaction.detail",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.reaction.detail"
}
}, {
"path": "Immunization.reaction.reported",
"min": 0,
"definition": "Self-reported indicator.",
"short": "Indicates self-reported reaction",
"mapping": [ {
"map": "(no such concept seems to exist for allergy/adverse reaction in HL7 v2)",
"identity": "v2"
}, {
"map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.reaction.reported",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.reaction.reported"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol",
"min": 0,
"definition": "Contains information about the protocol(s) under which the vaccine was administered.",
"short": "What protocol was followed",
"mapping": [ {
"map": "(HL7 v2 doesn't seem to provide for this)",
"identity": "v2"
}, {
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "Immunization.vaccinationProtocol",
"base": {
"max": "*",
"min": 0,
"path": "Immunization.vaccinationProtocol"
}
}, {
"path": "Immunization.vaccinationProtocol.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccinationProtocol.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Immunization.vaccinationProtocol.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccinationProtocol.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Immunization.vaccinationProtocol.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Immunization.vaccinationProtocol.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Immunization.vaccinationProtocol.doseSequence",
"min": 0,
"definition": "Nominal position in a series.",
"short": "Dose number within series",
"mapping": [ {
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sequenceNumber",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.doseSequence",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.vaccinationProtocol.doseSequence"
}
}, {
"path": "Immunization.vaccinationProtocol.description",
"min": 0,
"definition": "Contains the description about the protocol under which the vaccine was administered.",
"short": "Details of vaccine protocol",
"mapping": [ {
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.description",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.vaccinationProtocol.description"
}
}, {
"path": "Immunization.vaccinationProtocol.authority",
"min": 0,
"definition": "Indicates the authority who published the protocol. E.g. ACIP.",
"short": "Who is responsible for protocol",
"mapping": [ {
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].participation[typeCode=AUT].COCT_MT090200UV",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.authority",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.vaccinationProtocol.authority"
}
}, {
"path": "Immunization.vaccinationProtocol.series",
"min": 0,
"definition": "One possible path to achieve presumed immunity against a disease - within the context of an authority.",
"short": "Name of vaccine series",
"mapping": [ {
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM]",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.series",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.vaccinationProtocol.series"
}
}, {
"path": "Immunization.vaccinationProtocol.seriesDoses",
"min": 0,
"definition": "The recommended number of doses to achieve immunity.",
"short": "Recommended number of doses for immunity",
"mapping": [ {
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.seriesDoses",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.vaccinationProtocol.seriesDoses"
}
}, {
"path": "Immunization.vaccinationProtocol.targetDisease",
"min": 1,
"definition": "The targeted disease.",
"short": "Disease immunized against",
"mapping": [ {
"map": "outboundRelationship.target[classCode=OBS].code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccinationProtocoltargetDisease"
} ],
"description": "The disease target of the vaccination protocol",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-target"
}
},
"max": "*",
"id": "Immunization.vaccinationProtocol.targetDisease",
"base": {
"max": "*",
"min": 1,
"path": "Immunization.vaccinationProtocol.targetDisease"
}
}, {
"path": "Immunization.vaccinationProtocol.doseStatus",
"min": 1,
"definition": "Indicates if the immunization event should \"count\" against the protocol.",
"short": "Indicates if dose counts towards immunity",
"mapping": [ {
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[classCode=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SBJ].observation[classCode=OBS].value",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccinationProtocolDoseStatus"
} ],
"description": "The status of the vaccination protocol (i.e. should this count)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-status"
}
},
"max": "1",
"id": "Immunization.vaccinationProtocol.doseStatus",
"comment": "May need to differentiate between status declarations by a provider vs. a CDS engine.",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.vaccinationProtocol.doseStatus"
}
}, {
"path": "Immunization.vaccinationProtocol.doseStatusReason",
"min": 0,
"definition": "Provides an explanation as to why an immunization event should or should not count against the protocol.",
"short": "Why dose does (not) count",
"mapping": [ {
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[classCode=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SBJ].observation[classCode=OBS].reasonCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccinationProtocolDoseStatusReason"
} ],
"description": "The reason for the determining if a vaccination should count or why vaccination should not count.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-status-reason"
}
},
"max": "1",
"id": "Immunization.vaccinationProtocol.doseStatusReason",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.vaccinationProtocol.doseStatusReason"
}
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "2.1.5"
} ]
},
"status": "active",
"id": "5969581f-46b7-4257-9138-6972dfc9c667",
"kind": "resource",
"url": "http://fhir.hl7.nl/zorgviewer/StructureDefinition/Immunization",
"version": "1.13.0",
"differential": {
"element": [ {
"id": "Immunization",
"path": "Immunization"
}, {
"id": "Immunization.vaccineCode.coding.display",
"path": "Immunization.vaccineCode.coding.display",
"mustSupport": true
}, {
"id": "Immunization.vaccineCode.text",
"path": "Immunization.vaccineCode.text",
"mustSupport": true
}, {
"id": "Immunization.date",
"path": "Immunization.date",
"mustSupport": true
}, {
"id": "Immunization.note.text",
"path": "Immunization.note.text",
"mustSupport": true
} ]
},
"contact": [ {
"name": "RIVO-NN",
"telecom": [ {
"value": "https://rivo-noord.nl",
"system": "url"
} ]
}, {
"name": "HL7NL",
"telecom": [ {
"value": "https://hl7.nl",
"system": "url"
} ]
} ],
"baseDefinition": "http://nictiz.nl/fhir/StructureDefinition/zib-Vaccination"
}