Logical Model
The following Logical Models are defined for Immunization.
Immunization Model
| Canonical | https://www.example.org/fhir/StructureDefinition/immunization-model |
| Model1 (Model-Immunization) | Element | Element idModel-Immunization A record of an immunization or vaccination DefinitionBase definition for all elements in a resource.
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idModel-Immunization.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idModel-Immunization.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| identifier | 0..1 | Identifier | Element idModel-Immunization.identifier The business identifier(s) for the vaccination entry DefinitionThe business identifier(s) for the vaccination entry - This is an optional attribute, used for example to track an entry throughout its lifecycle, or across vaults.
| |
| status | 1..1 | code | Element idModel-Immunization.status The status of this vaccination record entry DefinitionThe status of the vaccination record entry - whether it is active, entered in error, etc.
| |
| statusReason | 0..1 | CodeableConcept | Element idModel-Immunization.statusReason The reason for the status e.g. 'not completed because...' DefinitionSupporting reason for status information. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
| |
| patient | I | 1..1 | Reference(Patient) | Element idModel-Immunization.patient The patient that received immunization. DefinitionThe patient that has received the immunization. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| vaccineCode | 1..1 | CodeableConcept | Element idModel-Immunization.vaccineCode The vaccine code, typically identified by the diseas(s) it covers. For example MMR, HPV, Tetanus, DTPa DefinitionThe vaccine code - a type of vaccine, typically identified by the disease(s) it covers. For example MMR, HPV, Tetanus, DTPa. This should be a coded value. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
| |
| vaccinationDate[x] | 0..1 | Element idModel-Immunization.vaccinationDate[x] The date and time when the vaccination has been administered DefinitionThe date and/or time when the immunization administration has been administered or presumed to be administered
| ||
| vaccinationDateDateTime | dateTime | Data type | ||
| vaccinationDateString | string | Data type | ||
| vaccinationRequest | I | 0..1 | Reference() | Element idModel-Immunization.vaccinationRequest The patient-specific order or recommendation for the vaccination DefinitionThe patient-specific order or recommendation for the vaccination, for example a prescription or a request for vaccination for a patient by a physician, for example for optional vaccines. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| protocol | I | 0..1 | Reference() | Element idModel-Immunization.protocol The vaccination plan or protocol (not patient-specific) that this vaccination is fulfilling DefinitionThe vaccination plan or protocol (not patient-specific) that this vaccination is fulfilling. For example 'Basisvaccinatieschema' References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| type | 1..1 | code | Element idModel-Immunization.type The type of vaccination action - for example first dose or reinforcement. DefinitionThe type of vaccination action - for example first dose or reinforcement.
| |
| sequenceNumber | 0..1 | string | Element idModel-Immunization.sequenceNumber The sequence number of an immunization - whether it is the first dose, or second dose... DefinitionThe sequence number of an immunization when part of a protocol - if it is the first dose, or second dose... Note that FHIR strings SHALL NOT exceed 1MB in size
| |
| reporter | I | 1..1 | Reference(Practitioner) | Element idModel-Immunization.reporter The professional that recorded the administration of the vaccine DefinitionThe professional that recorded the administration of the vaccine. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| recorded | 1..1 | dateTime | Element idModel-Immunization.recorded The date and time when the administration of the vaccine was recorded DefinitionThe date and time when the administration of the vaccine was recorded - typically used when the vaccine event is recorded a posteriori.
| |
| performer | I | 1..1 | Reference(Practitioner) | Element idModel-Immunization.performer The professional that administered the medication DefinitionThe professional that administered the medication. Use code "unknown" if not known. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| route | 0..1 | CodeableConcept | Element idModel-Immunization.route The route of administration. DefinitionThe route of administration for the vaccine. This can be free text (not desired) or a code Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.
| |
| administeredProduct | 1..1 | BackboneElement | Element idModel-Immunization.administeredProduct The details of the product that was administered. DefinitionThe details of the product that was administered
| |
| id | 0..1 | string | There are no (further) constraints on this element Element idModel-Immunization.administeredProduct.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idModel-Immunization.administeredProduct.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idModel-Immunization.administeredProduct.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay 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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
| product | I | 1..1 | Reference() | Element idModel-Immunization.administeredProduct.product The actual product that was administered. This should be a produc code or a reference to an actual Medication resource DefinitionThe actual product that was administered. This can be just text (not desired), or a code (e.g. 1696392 = Neisvac C Dos 0,5ml) or a reference to an actual Medication product (e.g. http://server/Medication/1696392) In the case where the product is not known, use code "unknown"
|
| lotNumber | 0..1 | string | Element idModel-Immunization.administeredProduct.lotNumber The lot number DefinitionThe lot number Note that FHIR strings SHALL NOT exceed 1MB in size
| |
| expirationDate | 0..1 | date | Element idModel-Immunization.administeredProduct.expirationDate The expiration date of the product. DefinitionThe expiration date of the product.
| |
| location | I | 0..1 | Reference() | Element idModel-Immunization.location The location where the immunization is performed. DefinitionThe location where the immunization administration was performed. This can be a text (e.g. 'at the physician's office' or a code e.g. '00078' meaning 'patient's home' or a resource (Location) if one exists e.g. 'Location/kind-en-gezin-092375' which could be defining 'Kind en Gezin Gent Koepoortkaai' References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| note | I | 0..1 | Attachment | Element idModel-Immunization.note Additional notes for the vaccination. DefinitionAdditional notes for the vaccination When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
|