{ "resourceType": "StructureDefinition", "id": "Immunization-uv-trillium2", "meta": { "lastUpdated": "2018-03-07T17:47:01.502+00:00" }, "url": "http://trilliumbridge.eu/fhir/StructureDefinition/immunization-uv-trillium2", "name": "Immunization-uv-trillium2", "title": "Immunization (Trillium II)", "status": "draft", "date": "2018-03-06", "description": "This profile represents the constraints applied to the Immunization resource by the Trillium II project on 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\n Information about that statement (e.g. who did the assertion, when was done) are optionally provided by the statement-uv-ips extension", "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 Trillium II project on 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 statement extension." }, { "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/uv/ips/StructureDefinition/statement-uv-ips" } ], "mustSupport": true }, { "id": "Immunization.status", "path": "Immunization.status", "mustSupport": 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": { "description": "This slicing on the coding element of vaccineCode is open, with discriminator based on the value set binding. It supports both identifiers and categories or classes for representing the vaccine. \r\n It carries one slice representign the vaccine type (e.g. MMR vaccine); one slice for each of the IDMP identifiers, or any equivalent representation of these concepts (e.g. medical product); plus one slice for the ATC classification. \r\nOther representations of the medication (such as SNOMED CT, RxNorm, jurisdictional code systems, cross-jursisdiction code systems, or any classification) use extra slices, since the slicing is open. \r\n A special slice is defined to carry the absent or unknown property.\r\nThe value sets used by the IDMP slices are provisional and include few concepts for exemplification purposes, they will be updated with real IDMP identifiers when they will become available.", "rules": "openAtEnd" }, "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/uv/ips/StructureDefinition/Coding-uv-ips" } ] }, { "id": "Immunization.vaccineCode.coding:vaccineType", "path": "Immunization.vaccineCode.coding", "sliceName": "vaccineType", "short": "Type of the Vaccine", "definition": "The type of vaccine for particular disease or diseases against which the patient has been immunised.", "type": [ { "code": "Coding", "profile": "http://hl7.org/fhir/uv/ips/StructureDefinition/Coding-uv-ips" } ], "mustSupport": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "VaccineType" } ], "strength": "preferred", "valueSetUri": "http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips" } }, { "id": "Immunization.vaccineCode.coding:pharmaceuticalProduct-L1", "path": "Immunization.vaccineCode.coding", "sliceName": "pharmaceuticalProduct-L1", "short": "Pharmaceutical Product Identifier, Level 1, [Substance(s)]. Example: Amoxicillin and Clavulanate Potassium", "definition": "IDMP PhPID Level 1 (Implies substances) 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 s 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/uv/ips/StructureDefinition/Coding-uv-ips" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PhPIDLvl1" } ], "strength": "example", "valueSetUri": "http://hl7.org/fhir/uv/ips/ValueSet/phpid-lvl1-uv-ips" } }, { "id": "Immunization.vaccineCode.coding:pharmaceuticalProduct-L2", "path": "Immunization.vaccineCode.coding", "sliceName": "pharmaceuticalProduct-L2", "short": "Pharmaceutical Product Identifier, Level 2 [Substance(s) + Strength + reference strength]. Example: Amoxicillin 875 mg and Clavulanate Potassium 125 mg.", "definition": "IDMP PhPID Level 2 (Implies substances 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 substances 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/uv/ips/StructureDefinition/Coding-uv-ips" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PhPIDLvl2" } ], "strength": "example", "valueSetUri": "http://hl7.org/fhir/uv/ips/ValueSet/phpid-lvl2-uv-ips" } }, { "id": "Immunization.vaccineCode.coding:pharmaceuticalProduct-L3", "path": "Immunization.vaccineCode.coding", "sliceName": "pharmaceuticalProduct-L3", "short": "Pharmaceutical Product Identifier, Level 3 [Substance(s) + administrable dose form]. Example: Amoxicillin and Clavulanate Potassium, Oral Tablet.", "definition": "IDMP PhPID Level 3 (Implies substances 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 substances and administrable dose form, 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/uv/ips/StructureDefinition/Coding-uv-ips" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PhPIDLvl3" } ], "strength": "example", "valueSetUri": "http://hl7.org/fhir/uv/ips/ValueSet/phpid-lvl3-uv-ips" } }, { "id": "Immunization.vaccineCode.coding:pharmaceuticalProduct-L4", "path": "Immunization.vaccineCode.coding", "sliceName": "pharmaceuticalProduct-L4", "short": "Pharmaceutical Product Identifier, Level 4 [Substance(s) + strength + reference strength + administrable dose form]. Example: Amoxicillin 875 mg and clavulanate potassium 125 mg, oral tablet.", "definition": "IDMP PhPID Level 4 (Implies substances, 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 substances and administrable dose form, 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/uv/ips/StructureDefinition/Coding-uv-ips" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PhPIDLvl4" } ], "strength": "example", "valueSetUri": "http://hl7.org/fhir/uv/ips/ValueSet/phpid-lvl4-uv-ips" } }, { "id": "Immunization.vaccineCode.coding:medicinalProduct", "path": "Immunization.vaccineCode.coding", "sliceName": "medicinalProduct", "short": "Medicinal Product", "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/uv/ips/StructureDefinition/Coding-uv-ips" } ], "mustSupport": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "MPID" } ], "strength": "example", "valueSetUri": "http://hl7.org/fhir/uv/ips/ValueSet/mpid-uv-ips" } }, { "id": "Immunization.vaccineCode.coding:packagedProduct", "path": "Immunization.vaccineCode.coding", "sliceName": "packagedProduct", "short": "Packaged Medicinal Product", "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/uv/ips/StructureDefinition/Coding-uv-ips" } ], "mustSupport": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PCID" } ], "strength": "example", "valueSetUri": "http://hl7.org/fhir/uv/ips/ValueSet/pcid-uv-ips" } }, { "id": "Immunization.vaccineCode.coding:atcClass", "path": "Immunization.vaccineCode.coding", "sliceName": "atcClass", "short": "WHO ATC classification", "definition": "WHO ATC classification", "max": "1", "type": [ { "code": "Coding", "profile": "http://hl7.org/fhir/uv/ips/StructureDefinition/Coding-uv-ips" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "WHO ATC" } ], "strength": "required", "valueSetUri": "http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips" } }, { "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/uv/ips/StructureDefinition/Coding-uv-ips" } ], "mustSupport": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Absent Unknown Immunization" } ], "strength": "required", "valueSetUri": "http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunization-uv-ips" } }, { "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", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips" } ], "mustSupport": true }, { "id": "Immunization.patient.reference", "path": "Immunization.patient.reference", "min": 1, "mustSupport": true }, { "id": "Immunization.date", "path": "Immunization.date", "min": 1, "max": "1", "mustSupport": true }, { "id": "Immunization.date.extension", "path": "Immunization.date.extension", "sliceName": "data-absent-reason", "short": "date absence reason", "definition": "Provides a reason why the date is missing.", "max": "1", "type": [ { "code": "Extension", "profile": "http://hl7.org/fhir/StructureDefinition/data-absent-reason" } ], "mustSupport": true }, { "id": "Immunization.site.coding", "path": "Immunization.site.coding", "type": [ { "code": "Coding", "profile": "http://hl7.org/fhir/uv/ips/StructureDefinition/Coding-uv-ips" } ], "binding": { "strength": "preferred", "valueSetUri": "http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips" } }, { "id": "Immunization.route", "path": "Immunization.route" }, { "id": "Immunization.route.coding", "path": "Immunization.route.coding", "type": [ { "code": "Coding", "profile": "http://hl7.org/fhir/uv/ips/StructureDefinition/Coding-uv-ips" } ], "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "ImmunizationRoute" } ], "strength": "required", "valueSetUri": "http://hl7.org/fhir/uv/ips/ValueSet/medicine-route-of-administration" } }, { "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.vaccinationProtocol", "path": "Immunization.vaccinationProtocol" }, { "id": "Immunization.vaccinationProtocol.extension:vaccinationValidity", "path": "Immunization.vaccinationProtocol.extension", "sliceName": "vaccinationValidity", "short": "Validity of Vaccination in years, months, days OR exprssed as a period of time", "definition": "Validity of Vaccination", "max": "1", "type": [ { "code": "Extension", "profile": "http://hl7.org/fhir/uv/ips/StructureDefinition/vaccinationValidity-immunization-uv-trillium2" } ] }, { "id": "Immunization.vaccinationProtocol.targetDisease.coding", "path": "Immunization.vaccinationProtocol.targetDisease.coding", "type": [ { "code": "Coding", "profile": "http://hl7.org/fhir/uv/ips/StructureDefinition/Coding-uv-ips" } ] }, { "id": "Immunization.vaccinationProtocol.doseStatus.coding", "path": "Immunization.vaccinationProtocol.doseStatus.coding", "type": [ { "code": "Coding", "profile": "http://hl7.org/fhir/uv/ips/StructureDefinition/Coding-uv-ips" } ] } ] } }