{ "resourceType": "StructureDefinition", "meta": { "lastUpdated": "2018-03-07T17:47:01.502+00:00" }, "url": "http://hl7.org/fhir/ips/StructureDefinition/immunization-uv-ips", "name": "Immunization-uv-ips", "title": "Immunization", "status": "draft", "date": "2018-03-06", "description": "This profile represents the constraints applied to the Immunization resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of an immunization is represented in the patient summary as an instance of an Immunization resource constrained by this profile.\r\n\r\nIt 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.\r\n\r\nTwo extensions are optionally used by this profile:\r\n(1) the first one provides the details about the assertion (e.g. who did the assertion, when was done);\r\n(2) The second one provides the list of diseases targeted by this vaccine.\r\n\r\nThe vaccinationProtocol has been removed by this version of the profile as pre-adoption of the R4.", "purpose": "This profile constrains the representation of a record of a vaccination of the patient, in the context of the international patient summary as specified by the IPS project of HL7 International.", "fhirVersion": "3.0.1", "kind": "resource", "abstract": false, "type": "Immunization", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization", "derivation": "constraint", "differential": { "element": [ { "id": "Immunization", "path": "Immunization", "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.\r\n\r\nIf it describes a reported information the details about the assertion (e.g. who did the assertion, when was done) can be optionally documented in the in the statement extension." }, { "id": "Immunization.extension", "path": "Immunization.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" } }, { "id": "Immunization.extension:statementDetails", "path": "Immunization.extension", "sliceName": "statementDetails", "short": "Immunization Statement detail", "definition": "Information about who reported this immunization and when", "max": "1", "type": [ { "code": "Extension", "profile": "http://hl7.org/fhir/ips/StructureDefinition/statement-uv-ips" } ] }, { "id": "Immunization.extension:statementDetails.extension:statementNote", "path": "Immunization.extension.extension", "sliceName": "statementNote", "max": "0" }, { "id": "Immunization.extension:targetDiseases", "path": "Immunization.extension", "sliceName": "targetDiseases", "short": "Target disease", "definition": "Disease targeted by this vaccine", "type": [ { "code": "Extension", "profile": "http://hl7.org/fhir/ips/StructureDefinition/targetdiseases-immunization-uv-ips" } ], "mustSupport": true }, { "id": "Immunization.status", "path": "Immunization.status", "fixedCode": "completed", "mustSupport": true }, { "id": "Immunization.notGiven", "path": "Immunization.notGiven", "comment": "This element is always false for the IPS as we report immunization that happened", "fixedBoolean": true }, { "id": "Immunization.vaccineCode", "path": "Immunization.vaccineCode", "definition": "Vaccine that was administered or was to be administered.\r\nSeveral kinds of vaccine product coding could be provided .\r\n\r\nThe IPS requires that either the Vaccine for type of disease or the known absent / unknown code is provided.\r\n\r\nOther coded information that identifies / classifies the administered product (e.g. the medicinal prodoct or the product class), including IDMP identifiers, can be provided as well.", "mustSupport": true }, { "id": "Immunization.vaccineCode.coding", "path": "Immunization.vaccineCode.coding", "slicing": { "discriminator": [ { "type": "value", "path": "system" } ], "description": "This slicing on the coding element of vaccineCode is open, with discriminator based on the value of the Coding.system element. It supports both identifiers and categories or classes for representing the vaccine. \r\nIt carries one slice for each of the IDMP identifiers, plus one slice for the ATC classification. \r\nA special slice is defined to carry the absent or unknown property.\r\nOther representations of the vaccine (such as SNOMED CT, RxNorm, jurisdictional code systems, cross-jursisdiction code systems, or any classification) use extra slices, since the slicing is open. \r\nThe IDMP slices are provisional, and will be usable when the IDMP identifiers become available.", "rules": "open" }, "definition": "A representation of the vaccine in a code system. The representation can be granular or may also be a class or category.", "type": [ { "code": "Coding", "profile": "http://hl7.org/fhir/ips/StructureDefinition/coding-uv-ips" } ] }, { "id": "Immunization.vaccineCode.coding:pharmaceuticalProduct-L1", "path": "Immunization.vaccineCode.coding", "sliceName": "pharmaceuticalProduct-L1", "short": "Pharmaceutical Product Identifier, Level 1", "definition": "IDMP PhPID Level 1 (Implies ingredients) or any equivalent Pharmaceutical Product identifier.\r\n\r\nPharmaceutical Product Identifier (PhPID): Uniquely identifies medicinal product based on the\r\ngeneric composition, such as ingredients and route of administration, separate from any other\r\ndetails such as regulatory authorisation, organisation, packaging or naming. The PhPID can be\r\nspecified at various levels of detail for a given Pharmaceutical Product.", "type": [ { "code": "Coding", "profile": "http://hl7.org/fhir/ips/StructureDefinition/coding-uv-ips" } ] }, { "id": "Immunization.vaccineCode.coding:pharmaceuticalProduct-L1.system", "path": "Immunization.vaccineCode.coding.system", "min": 1, "fixedUri": "http://hl7.org/fhir/sid/phpid-l1" }, { "id": "Immunization.vaccineCode.coding:pharmaceuticalProduct-L1.code", "path": "Immunization.vaccineCode.coding.code", "min": 1 }, { "id": "Immunization.vaccineCode.coding:pharmaceuticalProduct-L2", "path": "Immunization.vaccineCode.coding", "sliceName": "pharmaceuticalProduct-L2", "short": "Pharmaceutical Product Identifier, Level 2", "definition": "IDMP PhPID Level 2 (Implies ingredients and strength) or any equivalent Pharmaceutical Product identifier.\r\n\r\nPharmaceutical Product Identifier (PhPID): Uniquely identifies medicinal product based on the\r\ngeneric composition, such as ingredients and route of administration, separate from any other\r\ndetails such as regulatory authorisation, organisation, packaging or naming. The PhPID can be\r\nspecified at various levels of detail for a given Pharmaceutical Product.", "type": [ { "code": "Coding", "profile": "http://hl7.org/fhir/ips/StructureDefinition/coding-uv-ips" } ] }, { "id": "Immunization.vaccineCode.coding:pharmaceuticalProduct-L2.system", "path": "Immunization.vaccineCode.coding.system", "min": 1, "fixedUri": "http://hl7.org/fhir/sid/phpid-l2" }, { "id": "Immunization.vaccineCode.coding:pharmaceuticalProduct-L2.code", "path": "Immunization.vaccineCode.coding.code", "min": 1 }, { "id": "Immunization.vaccineCode.coding:pharmaceuticalProduct-L3", "path": "Immunization.vaccineCode.coding", "sliceName": "pharmaceuticalProduct-L3", "short": "Pharmaceutical Product Identifier, Level 3", "definition": "IDMP PhPID Level 3 (Implies ingredients and dose form) or any equivalent Pharmaceutical Product identifier.\r\n\r\nPharmaceutical Product Identifier (PhPID): Uniquely identifies medicinal product based on the\r\ngeneric composition, such as ingredients and route of administration, separate from any other\r\ndetails such as regulatory authorisation, organisation, packaging or naming. The PhPID can be\r\nspecified at various levels of detail for a given Pharmaceutical Product.", "type": [ { "code": "Coding", "profile": "http://hl7.org/fhir/ips/StructureDefinition/coding-uv-ips" } ] }, { "id": "Immunization.vaccineCode.coding:pharmaceuticalProduct-L3.system", "path": "Immunization.vaccineCode.coding.system", "min": 1, "fixedUri": "http://hl7.org/fhir/sid/phpid-l3" }, { "id": "Immunization.vaccineCode.coding:pharmaceuticalProduct-L3.code", "path": "Immunization.vaccineCode.coding.code", "min": 1 }, { "id": "Immunization.vaccineCode.coding:pharmaceuticalProduct-L4", "path": "Immunization.vaccineCode.coding", "sliceName": "pharmaceuticalProduct-L4", "short": "Pharmaceutical Product Identifier, Level 4", "definition": "IDMP PhPID Level 4 (Implies ingredients, strength, and dose form) or any equivalent Pharmaceutical Product identifier.\r\n\r\nPharmaceutical Product Identifier (PhPID): Uniquely identifies medicinal product based on the\r\ngeneric composition, such as ingredients and route of administration, separate from any other\r\ndetails such as regulatory authorisation, organisation, packaging or naming. The PhPID can be\r\nspecified at various levels of detail for a given Pharmaceutical Product.", "type": [ { "code": "Coding", "profile": "http://hl7.org/fhir/ips/StructureDefinition/coding-uv-ips" } ] }, { "id": "Immunization.vaccineCode.coding:pharmaceuticalProduct-L4.system", "path": "Immunization.vaccineCode.coding.system", "min": 1, "fixedUri": "http://hl7.org/fhir/sid/phpid-l4" }, { "id": "Immunization.vaccineCode.coding:pharmaceuticalProduct-L4.code", "path": "Immunization.vaccineCode.coding.code", "min": 1 }, { "id": "Immunization.vaccineCode.coding:medicinalProduct", "path": "Immunization.vaccineCode.coding", "sliceName": "medicinalProduct", "short": "Medicinal Product Identifier", "definition": "IDMP Medicinal Product Identifier (MPID) or any equivalent Medicinal Product Identifier.\r\n\r\nIDMP MPID uniquely identifies a Medicinal Product, reflecting (but not replacing) any other authorisation numbers allocated by a regulator.\r\n\r\nMPID implies one (set of) PhPID.\r\nThe MPID shall use a common segment pattern related to a Medicinal Product, which\r\nwhen each segment is valued shall define a specific MPID concept. The pattern is:\r\n• a) Country code segment (ISO 3166-1 alpha-2 code elements);\r\n• b) Marketing Authorization Holder (Organization Identifier) code segment;\r\n• c) Medicinal Product code segment (Unique Medicinal Product Identifier).\r\n• Any change of the values related to these three code segments shall result in the\r\nassignment of a new MPID.", "type": [ { "code": "Coding", "profile": "http://hl7.org/fhir/ips/StructureDefinition/coding-uv-ips" } ], "mustSupport": true }, { "id": "Immunization.vaccineCode.coding:medicinalProduct.system", "path": "Immunization.vaccineCode.coding.system", "min": 1, "fixedUri": "http://hl7.org/fhir/sid/mpid" }, { "id": "Immunization.vaccineCode.coding:medicinalProduct.code", "path": "Immunization.vaccineCode.coding.code", "min": 1 }, { "id": "Immunization.vaccineCode.coding:medicinalProduct.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.vaccineCode.coding.display", "short": "Name of the Medicinal Product", "definition": "Name of the Medicinal Product, in some cases it corresponds to the brand name." }, { "id": "Immunization.vaccineCode.coding:packagedProduct", "path": "Immunization.vaccineCode.coding", "sliceName": "packagedProduct", "short": "Packaged Medicinal Product Identifier", "definition": "IDMP Packaged Medicinal Product Identifier or any equivalent Packaged Medicinal Product Identifier.\r\n\r\nUniquely identifies a Medicinal Product based on its packaging. This implies one MPID can be associated with more than one PCID, if the same Medicinal Product has more than one type of package;\r\n\r\nThe PCID shall use a common segment pattern related to a package of a Medicinal\r\nProduct, which when each segment is valued, shall define a specific PCID concept. The\r\npattern is:\r\n• a) MPID for the Medicinal Product\r\n• b) package description code segment, which refers to a unique identifier for each\r\npackage.", "type": [ { "code": "Coding", "profile": "http://hl7.org/fhir/ips/StructureDefinition/coding-uv-ips" } ], "mustSupport": true }, { "id": "Immunization.vaccineCode.coding:packagedProduct.system", "path": "Immunization.vaccineCode.coding.system", "min": 1, "fixedUri": "http://hl7.org/fhir/sid/pcid" }, { "id": "Immunization.vaccineCode.coding:packagedProduct.code", "path": "Immunization.vaccineCode.coding.code", "min": 1 }, { "id": "Immunization.vaccineCode.coding:packagedProduct.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.vaccineCode.coding.display", "short": "Name of the Packaged Medicinal Product", "definition": "Name of the Packaged Medicinal Product, in some cases it corresponds to the brand name.", "mustSupport": false }, { "id": "Immunization.vaccineCode.coding:atcClass", "path": "Immunization.vaccineCode.coding", "sliceName": "atcClass", "short": "WHO ATC classification", "definition": "WHO classification or cluster of products such as ATC, SNOMED VMP or national/local classification of products", "max": "1", "type": [ { "code": "Coding", "profile": "http://hl7.org/fhir/ips/StructureDefinition/coding-uv-ips" } ], "binding": { "strength": "required", "valueSetReference": { "reference": "http://hl7.org/fhir/ips/ValueSet/whoatc-uv-ips" } } }, { "id": "Immunization.vaccineCode.coding:atcClass.system", "path": "Immunization.vaccineCode.coding.system", "min": 1, "fixedUri": "http://www.whocc.no/atc" }, { "id": "Immunization.vaccineCode.coding:atcClass.code", "path": "Immunization.vaccineCode.coding.code", "min": 1 }, { "id": "Immunization.vaccineCode.coding:absentOrUnknownImmunization", "path": "Immunization.vaccineCode.coding", "sliceName": "absentOrUnknownImmunization", "short": "Absent Unknown Immunization", "definition": "A reference to a code indicating that there there are no known immunizations or that this information is unknown.", "max": "1", "type": [ { "code": "Coding", "profile": "http://hl7.org/fhir/ips/StructureDefinition/coding-uv-ips" } ], "mustSupport": true, "binding": { "strength": "required", "valueSetUri": "http://hl7.org/fhir/ips/ValueSet/absent-or-unknown-immunization-uv-ips" } }, { "id": "Immunization.vaccineCode.coding:absentOrUnknownImmunization.system", "path": "Immunization.vaccineCode.coding.system", "min": 1, "fixedUri": "urn:oid:2.16.840.1.113883.3.1937.777.13.5.999.1" }, { "id": "Immunization.vaccineCode.coding:absentOrUnknownImmunization.code", "path": "Immunization.vaccineCode.coding.code", "min": 1 }, { "id": "Immunization.vaccineCode.text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "Immunization.vaccineCode.text", "comment": "The text should be at the displayName level and not on this level.", "mustSupport": true }, { "id": "Immunization.patient", "path": "Immunization.patient", "mustSupport": true }, { "id": "Immunization.patient.reference", "path": "Immunization.patient.reference", "mustSupport": true }, { "id": "Immunization.patient.identifier", "path": "Immunization.patient.identifier", "max": "0" }, { "id": "Immunization.date", "path": "Immunization.date", "min": 1, "mustSupport": true }, { "id": "Immunization.manufacturer.identifier", "path": "Immunization.manufacturer.identifier", "max": "0" }, { "id": "Immunization.site.coding", "path": "Immunization.site.coding", "type": [ { "code": "Coding", "profile": "http://hl7.org/fhir/ips/StructureDefinition/coding-uv-ips" } ], "binding": { "strength": "preferred", "valueSetUri": "http://hl7.org/fhir/ips/ValueSet/target-site-uv-ips" } }, { "id": "Immunization.route", "path": "Immunization.route", "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImmunizationRoute" } ], "strength": "required", "valueSetReference": { "reference": "http://hl7.org/fhir/ips/ValueSet/medicine-route-of-administration" } } }, { "id": "Immunization.route.coding", "path": "Immunization.route.coding", "type": [ { "code": "Coding", "profile": "http://hl7.org/fhir/ips/StructureDefinition/coding-uv-ips" } ], "binding": { "strength": "required", "valueSetUri": "http://hl7.org/fhir/ips/ValueSet/routeOfAdministration-uv-ips" } }, { "id": "Immunization.practitioner", "path": "Immunization.practitioner", "max": "1", "mustSupport": true }, { "id": "Immunization.practitioner.actor", "path": "Immunization.practitioner.actor", "mustSupport": true }, { "id": "Immunization.practitioner.actor.reference", "path": "Immunization.practitioner.actor.reference", "mustSupport": true }, { "id": "Immunization.practitioner.actor.identifier", "path": "Immunization.practitioner.actor.identifier", "max": "0" }, { "id": "Immunization.explanation.reasonNotGiven", "path": "Immunization.explanation.reasonNotGiven", "max": "1" }, { "id": "Immunization.explanation.reasonNotGiven.coding", "path": "Immunization.explanation.reasonNotGiven.coding", "type": [ { "code": "Coding", "profile": "http://hl7.org/fhir/ips/StructureDefinition/coding-uv-ips" } ] }, { "id": "Immunization.vaccinationProtocol", "path": "Immunization.vaccinationProtocol", "comment": "Preadoption of R4", "max": "0" } ] } }