{ "resourceType": "StructureDefinition", "id": "Immunization-my-core", "meta": { "lastUpdated": "2021-12-29T14:18:04.684+00:00" }, "text": { "status": "generated", "div": "
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\"ImmunizationS0..*ImmunizationImmunization event information
\".\"\".\"\".\"statusS1..1codecompleted | entered-in-error | not-done
\".\"\".\"\".\"vaccineCodeS1..1(Slice Definition)Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided.\n\n The MY Core assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code.\n\n Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.
Slice: Unordered, Open by pattern:$this
Binding: Vaccines - IPS (preferred)
\".\"\".\"\".\"\".\"vaccineCode:vaccineGPSCodeS0..1CodeableConceptCode for vaccine from the SNOMED CT GPS code set
Binding: Vaccines (GPS) - IPS (required)
\".\"\".\"\".\"\".\"vaccineCode:atcClassS0..1CodeableConceptWHO ATC classification
Binding: WHO ATC - IPS (required)
\".\"\".\"\".\"\".\"vaccineCode:absentOrUnknownImmunizationS0..1CodeableConceptAbsent Unknown Immunization
Binding: Absent or Unknown Immunization - IPS (required)
\".\"\".\"\".\"patientS1..1Reference(Patient (MY Core))Who was immunized
\".\"\".\"\".\"\".\"referenceS1..1stringLiteral reference, Relative, internal or absolute URL
\".\"\".\"\".\"occurrence[x]S1..1dateTime, stringVaccine administration date
\".\"\".\"\".\"\".\"data-absent-reasonS0..1codeoccurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
\".\"\".\"\".\"site0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Target Site - IPS (preferred)
\".\"\".\"\".\"routeS0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Route of Administration - IPS (preferred)
\".\"\".\"\".\"performerS0..1BackboneElementWho performed event
\".\"\".\"\".\"\".\"actorS1..1Reference(Practitioner | PractitionerRole | Organization)Individual or organization who was performing
\".\"\".\"\".\"protocolApplied0..*BackboneElementProtocol followed by the provider
\".\"\".\"\".\"\".\"targetDisease0..*(Slice Definition)Vaccine preventatable disease being targetted
Slice: Unordered, Open by pattern:$this
Binding: Vaccine Target Diseases - IPS (preferred)
\".\"\".\"\".\"\".\"\".\"targetDisease:targetDiseaseGPSCodeS0..1CodeableConceptCode for a disease the vaccination is against from the SNOMED CT GPS code set.
Binding: Vaccine Target Diseases (GPS) - IPS (required)

\"doco\" Documentation for this format
" }, "url": "http://hl7.org/fhir/my/core/StructureDefinition/Immunization-my-core", "version": "1.0.0", "name": "ImmunizationMyCore", "title": "Immunization (MY Core)", "status": "active", "date": "2022-01-01", "publisher": "Health Level Seven International - Patient Care Work Group", "contact": [ { "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/patientcare" } ] } ], "description": "This profile represents the constraints applied to the Immunization resource by the International Patient Summary (MY Core) 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.", "jurisdiction": [ { "coding": [ { "system": "http://unstats.un.org/unsd/methods/m49/m49.htm", "code": "001" } ] } ], "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 MY Core project of HL7 International.", "fhirVersion": "4.0.1", "mapping": [ { "identity": "workflow", "uri": "http://hl7.org/fhir/workflow", "name": "Workflow Pattern" }, { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping" }, { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" }, { "identity": "w5", "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping" }, { "identity": "cda", "uri": "http://hl7.org/v3/cda", "name": "CDA (R2)" } ], "kind": "resource", "abstract": false, "type": "Immunization", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization", "derivation": "constraint", "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", "mustSupport": true }, { "id": "Immunization.status", "path": "Immunization.status", "mustSupport": true }, { "id": "Immunization.vaccineCode", "path": "Immunization.vaccineCode", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "description": "Discriminated by bound value set", "rules": "open" }, "short": "Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided.\r\n\r\n The MY Core assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code.\r\n\r\n Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.", "definition": "Vaccine that was administered or was to be administered. Several kinds of vaccine product coding could be provided.\r\n\r\nThe MY Core assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunized is provided; or the known absent / unknown.\r\n\r\n Other coded information can be provided as well as:\r\n\r\n 1. The IDMP Pharmaceutical Product Identifier (PhPID), Level 1, [Substance(s)]. Example: Amoxicillin and Clavulanate Potassium; or any other equivalent coded concept.\r\n 2. The IDMP Pharmaceutical Product Identifier (PhPID), Level 2 [Substance(s) + Strength + reference strength]. Example: Amoxicillin 875 mg and Clavulanate Potassium 125 mg; or any other equivalent coded concept.\r\n 3. The IDMP Pharmaceutical Product Identifier (PhPID), Level 3 [Substance(s) + administrable dose form]. Example: Amoxicillin and Clavulanate Potassium, Oral Tablet; or any other equivalent coded concept.\r\n 4. The IDMP Pharmaceutical Product Identifier (PhPID), Level 4 [Substance(s) + strength + reference strength + administrable dose form]. Example: Amoxicillin 875 mg and clavulanate potassium 125 mg, oral tablet; or any other equivalent coded concept.\r\n 5. The IDMP Medicinal Product Identifier (MPID) or any equivalent Medicinal Product Identifier. IDMP MPID uniquely identifies a Medicinal Product, reflecting (but not replacing) any other authorization numbers allocated by a regulator. MPID implies one (set of) PhPID. The MPID shall use a common segment pattern related to a Medicinal Product, which, when each segment is valued shall define a specific MPID concept.\r\n 6. The IDMP Packaged Medicinal Product Identifier (PCID) or any equivalent Packaged Medicinal Product Identifier. Uniquely 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 7. Any other kind of code that that identifies, classifies or clusters the administered product (e.g. the medicinal product or the product class).\r\n\r\n The value sets used for the PhPID, MPID and PCID identifiers are provisional and include only few equivalent concepts used for exemplification purposes, they will be updated with real IDMP identifiers when they will become available.", "min": 1, "type": [ { "code": "CodeableConcept", "profile": [ "http://hl7.org/fhir/my/core/StructureDefinition/CodeableConcept-my-core" ] } ], "binding": { "strength": "preferred", "description": "The type of vaccine for particular disease or diseases against which the patient has been immunised.", "valueSet": "http://hl7.org/fhir/my/core/ValueSet/vaccines-my-core" } }, { "id": "Immunization.vaccineCode:vaccineGPSCode", "path": "Immunization.vaccineCode", "sliceName": "vaccineGPSCode", "short": "Code for vaccine from the SNOMED CT GPS code set", "definition": "Code for a vaccine that is selected from the SNOMED CT GPS code set.", "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/my/core/ValueSet/vaccines-gps-my-core" } }, { "id": "Immunization.vaccineCode:atcClass", "path": "Immunization.vaccineCode", "sliceName": "atcClass", "short": "WHO ATC classification", "definition": "WHO ATC classification", "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/my/core/ValueSet/whoatc-my-core" } }, { "id": "Immunization.vaccineCode:absentOrUnknownImmunization", "path": "Immunization.vaccineCode", "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.", "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/my/core/ValueSet/absent-or-unknown-immunizations-my-core" } }, { "id": "Immunization.patient", "path": "Immunization.patient", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/my/core/StructureDefinition/Patient-my-core" ] } ], "mustSupport": true }, { "id": "Immunization.patient.reference", "path": "Immunization.patient.reference", "min": 1, "mustSupport": true }, { "id": "Immunization.occurrence[x]", "path": "Immunization.occurrence[x]", "mustSupport": true }, { "id": "Immunization.occurrence[x].extension", "path": "Immunization.occurrence[x].extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "rules": "open" }, "min": 0 }, { "id": "Immunization.occurrence[x].extension:data-absent-reason", "path": "Immunization.occurrence[x].extension", "sliceName": "data-absent-reason", "short": "occurrence[x] absence reason", "definition": "Provides a reason why the occurrence is missing.", "min": 0, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/data-absent-reason" ] } ], "mustSupport": true }, { "id": "Immunization.site", "path": "Immunization.site", "type": [ { "code": "CodeableConcept", "profile": [ "http://hl7.org/fhir/my/core/StructureDefinition/CodeableConcept-my-core" ] } ], "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/my/core/ValueSet/target-site-my-core" } }, { "id": "Immunization.route", "path": "Immunization.route", "type": [ { "code": "CodeableConcept", "profile": [ "http://hl7.org/fhir/my/core/StructureDefinition/CodeableConcept-my-core" ] } ], "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/my/core/ValueSet/medicine-route-of-administration" } }, { "id": "Immunization.performer", "path": "Immunization.performer", "max": "1", "mustSupport": true }, { "id": "Immunization.performer.actor", "path": "Immunization.performer.actor", "mustSupport": true }, { "id": "Immunization.protocolApplied.targetDisease", "path": "Immunization.protocolApplied.targetDisease", "slicing": { "discriminator": [ { "type": "pattern", "path": "$this" } ], "description": "Discriminated by bound value set", "rules": "open" }, "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/my/core/ValueSet/targetDiseases-my-core" } }, { "id": "Immunization.protocolApplied.targetDisease:targetDiseaseGPSCode", "path": "Immunization.protocolApplied.targetDisease", "sliceName": "targetDiseaseGPSCode", "short": "Code for a disease the vaccination is against from the SNOMED CT GPS code set.", "definition": "Code for a disease the vaccination is against from the SNOMED CT GPS code set.", "max": "1", "mustSupport": true, "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/my/core/ValueSet/targetDiseases-gps-my-core" } } ] } }