| Immunization_uv_ips (Immunization) | S | | http://hl7.org/fhir/StructureDefinition/Immunization | There are no (further) constraints on this element Element idImmunization DefinitionDescribes 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
Data typehttp://hl7.org/fhir/StructureDefinition/Immunization |
| id | S | | | There are no (further) constraints on this element Element idImmunization.id |
| meta | S | | | There are no (further) constraints on this element Element idImmunization.meta |
| profile | S | | | There are no (further) constraints on this element Element idImmunization.meta.profile |
| status | S | | | There are no (further) constraints on this element Element idImmunization.status |
| vaccineCode | S | 1..1 | Codeable Concept (IPS)Binding | There are no (further) constraints on this element Element idImmunization.vaccineCode Short descriptionVaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided.
The IPS 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.
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 AC codes; or any other kind of code that that identifies, classifies or cluster the administered product. DefinitionVaccine that was administered or was to be administered. Several kinds of vaccine product coding could be provided.
The IPS 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.
Other coded information can be provided as well as:
- The IDMP Pharmaceutical Product Identifier (PhPID), Level 1, [Substance(s)]. Example: Amoxicillin and Clavulanate Potassium; or any other equivalent coded concept;
- 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;
- 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;
- 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 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.
- 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.
- Any other kind of code that that identifies, classifies or cluster the administered product (e.g. the medicinal product or the product class)
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.
Data typeCodeable Concept (IPS) SlicingUnordered, Open, by coding.system(Value) Discriminated by code system BindingThe type of vaccine for particular disease or diseases against which the patient has been immunised. IPSVaccines (preferred) |
| (All Slices) | | | | The requirements in this element apply to all slices |
| coding | S | 1.. | | There are no (further) constraints on this element Element idImmunization.vaccineCode.coding DefinitionA representation of the vaccine in a code system. The representation can be granular or may also be a class or category.
SlicingUnordered, Open, by system(Value) Discriminated by code system |
| atcClass | S | ..1 | Binding | There are no (further) constraints on this element Element idImmunization.vaccineCode.coding:atcClass Short descriptionWHO ATC classification DefinitionBindingWHOATC (required) |
| system | S | 1..1 | Fixed Value | There are no (further) constraints on this element Element idImmunization.vaccineCode.coding:atcClass.system Fixed valuehttp://www.whocc.no/atc |
| absentOrUnknownImmunization | S | 0..1 | Codeable Concept (IPS)Binding | There are no (further) constraints on this element Element idImmunization.vaccineCode:absentOrUnknownImmunization Short descriptionAbsent Unknown Immunization DefinitionA reference to a code indicating that there there are no known immunizations or that this information is unknown.
Data typeCodeable Concept (IPS) BindingIPSNoImmunizationInfo (required) |
| coding | S | 1..1 | | There are no (further) constraints on this element Element idImmunization.vaccineCode:absentOrUnknownImmunization.coding |
| system | S | 1..1 | Fixed Value | There are no (further) constraints on this element Element idImmunization.vaccineCode:absentOrUnknownImmunization.coding.system Fixed valuehttp://hl7.org/fhir/uv/ips/CodeSystem/absent-unknown-uv-ips |
| text | S | | | There are no (further) constraints on this element Element idImmunization.vaccineCode:absentOrUnknownImmunization.text CommentsThe text should be at the displayName level and not on this level.
|
| patient | S | | Reference(Patient (IPS)) | There are no (further) constraints on this element Element idImmunization.patient Data typeReference(Patient (IPS)) |
| reference | S | 1.. | | There are no (further) constraints on this element Element idImmunization.patient.reference |
| occurrence[x] | S | 1..1 | | There are no (further) constraints on this element Element idImmunization.occurrence[x] |
| data-absent-reason | S | ..1 | Extension(code) | There are no (further) constraints on this element Element idImmunization.occurrence[x].extension:data-absent-reason Short descriptionoccurrence[x] absence reason DefinitionProvides a reason why the occurrence is missing.
Data typeExtension(code) Extension URLData Absent Reason |
| recorded | S | | | There are no (further) constraints on this element Element idImmunization.recorded |
| primarySource | S | | | There are no (further) constraints on this element Element idImmunization.primarySource |
| reportOrigin | S | | | There are no (further) constraints on this element Element idImmunization.reportOrigin |
| site | S | | Codeable Concept (IPS)Binding | There are no (further) constraints on this element Element idImmunization.site Data typeCodeable Concept (IPS) BindingIPSTargetSiteCode (preferred) |
| route | S | | Codeable Concept (IPS)Binding | There are no (further) constraints on this element Element idImmunization.route Data typeCodeable Concept (IPS) BindingIPSRouteOfAdmin (required) |
| performer | S | ..1 | | There are no (further) constraints on this element Element idImmunization.performer |
| actor | S | | | There are no (further) constraints on this element Element idImmunization.performer.actor |
| reference | S | | | There are no (further) constraints on this element Element idImmunization.performer.actor.reference |