This page is part of the International Patient Summary Implementation Guide (v1.1.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Page standards status: Trial-use | Maturity Level: 2 |
Definitions for the Immunization-uv-ips resource profile.
1. 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 Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party. | ||||||||||||
2. Immunization.status | |||||||||||||
Must Support | true | ||||||||||||
3. Immunization.vaccineCode | |||||||||||||
Definition | Vaccine 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 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. Vaccine that was administered or was to be administered. | ||||||||||||
Binding | The codes SHOULD be taken from Vaccines - IPSFor example codes, see VaccineAdministeredValueSet The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization. The code for vaccine product administered.
| ||||||||||||
Type | CodeableConcept(CodeableConceptIPS) | ||||||||||||
Must Support | true | ||||||||||||
4. Immunization.patient | |||||||||||||
Type | Reference(PatientUvIps|Patient)) | ||||||||||||
Must Support | true | ||||||||||||
5. Immunization.patient.reference | |||||||||||||
Control | 1..? | ||||||||||||
Must Support | true | ||||||||||||
6. Immunization.occurrence[x] | |||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Must Support | true | ||||||||||||
7. Immunization.occurrence[x].extension:data-absent-reason | |||||||||||||
SliceName | data-absent-reason | ||||||||||||
Definition | Provides a reason why the occurrence is missing. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Extension(Data Absent Reason) (Extension Type: code) | ||||||||||||
Must Support | true | ||||||||||||
8. Immunization.site | |||||||||||||
Binding | The codes SHOULD be taken from SNOMEDCTBodyStructuresFor example codes, see CodesForImmunizationSiteOfAdministration | ||||||||||||
Type | CodeableConcept(CodeableConceptIPS) | ||||||||||||
9. Immunization.route | |||||||||||||
Binding | The codes SHOULD be taken from Medicine Route of Administration - IPSFor example codes, see ImmunizationRouteCodes | ||||||||||||
Type | CodeableConcept(CodeableConceptIPS) | ||||||||||||
10. Immunization.protocolApplied | |||||||||||||
11. Immunization.protocolApplied.targetDisease | |||||||||||||
Definition | The particular disease against which the patient has been immunized. Additional conformance bindings provided for use for this element in specific (jurisdictional or other) contexts include (these bindings are represented in the StructureDefinition as instances of the elementdefinition-additionalBinding extension): The vaccine preventable disease the dose is being administered against. | ||||||||||||
Binding | The codes SHOULD be taken from Vaccine Target Diseases - IPSFor example codes, see ImmunizationTargetDiseaseCodes The particular disease or diseases against which the patient has been immunized. The vaccine preventable disease the dose is being administered for.
|
1. 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 Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party. | ||||||||||||
Control | 0..* | ||||||||||||
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) | ||||||||||||
2. Immunization.implicitRules | |||||||||||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | uri | ||||||||||||
Is Modifier | true | ||||||||||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
3. Immunization.modifierExtension | |||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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). | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true | ||||||||||||
Requirements | 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. | ||||||||||||
Alternate Names | extensions, user content | ||||||||||||
Comments | 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. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
4. Immunization.status | |||||||||||||
Definition | Indicates the current status of the immunization event. | ||||||||||||
Control | 1..1 | ||||||||||||
Binding | The codes SHALL be taken from ImmunizationStatusCodes A set of codes indicating the current status of an Immunization. | ||||||||||||
Type | code | ||||||||||||
Is Modifier | true | ||||||||||||
Must Support | true | ||||||||||||
Comments | Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
5. Immunization.vaccineCode | |||||||||||||
Definition | Vaccine 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 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. Vaccine that was administered or was to be administered. | ||||||||||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Binding | The codes SHOULD be taken from Vaccines - IPSFor example codes, see VaccineAdministeredValueSet The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization. The code for vaccine product administered.
| ||||||||||||
Type | CodeableConcept(CodeableConceptIPS) | ||||||||||||
Must Support | true | ||||||||||||
Comments | 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. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
6. Immunization.patient | |||||||||||||
Definition | The patient who either received or did not receive the immunization. | ||||||||||||
Control | 1..1 | ||||||||||||
Type | Reference(PatientUvIps|Patient)) | ||||||||||||
Must Support | true | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
7. Immunization.patient.reference | |||||||||||||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||||||||||
Control | 10..1 This element is affected by the following invariants: ref-1 | ||||||||||||
Type | string | ||||||||||||
Must Support | true | ||||||||||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
8. Immunization.occurrence[x] | |||||||||||||
Definition | Date vaccine administered or was to be administered. | ||||||||||||
Control | 1..1 | ||||||||||||
Type | Choice of: dateTime, string | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Must Support | true | ||||||||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||||||||
Comments | When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
9. Immunization.occurrence[x].extension:data-absent-reason | |||||||||||||
SliceName | data-absent-reason | ||||||||||||
Definition | Provides a reason why the occurrence is missing. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Extension(Data Absent Reason) (Extension Type: code) | ||||||||||||
Must Support | true | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
10. Immunization.site | |||||||||||||
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Body site where vaccine was administered. | ||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Binding | The codes SHOULD be taken from SNOMEDCTBodyStructuresFor example codes, see CodesForImmunizationSiteOfAdministration | ||||||||||||
Type | CodeableConcept(CodeableConceptIPS) | ||||||||||||
Comments | 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. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
11. Immunization.route | |||||||||||||
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. The path by which the vaccine product is taken into the body. | ||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Binding | The codes SHOULD be taken from Medicine Route of Administration - IPSFor example codes, see ImmunizationRouteCodes | ||||||||||||
Type | CodeableConcept(CodeableConceptIPS) | ||||||||||||
Comments | 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. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
12. Immunization.isSubpotent | |||||||||||||
Definition | Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | boolean | ||||||||||||
Is Modifier | true | ||||||||||||
Comments | Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event. | ||||||||||||
Meaning if Missing | By default, a dose should be considered to be potent. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
13. Immunization.protocolApplied | |||||||||||||
Definition | The protocol (set of recommendations) being followed by the provider who administered the dose. | ||||||||||||
Control | 0..* | ||||||||||||
Type | BackboneElement | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
14. Immunization.protocolApplied.modifierExtension | |||||||||||||
Definition | May 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). | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true | ||||||||||||
Requirements | 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. | ||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||
Comments | 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. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
15. Immunization.protocolApplied.targetDisease | |||||||||||||
Definition | The particular disease against which the patient has been immunized. Additional conformance bindings provided for use for this element in specific (jurisdictional or other) contexts include (these bindings are represented in the StructureDefinition as instances of the elementdefinition-additionalBinding extension): The vaccine preventable disease the dose is being administered against. | ||||||||||||
Control | 0..* | ||||||||||||
Binding | The codes SHOULD be taken from Vaccine Target Diseases - IPSFor example codes, see ImmunizationTargetDiseaseCodes The particular disease or diseases against which the patient has been immunized. The vaccine preventable disease the dose is being administered for.
| ||||||||||||
Type | CodeableConcept | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
16. Immunization.protocolApplied.doseNumber[x] | |||||||||||||
Definition | Nominal position in a series. | ||||||||||||
Control | 1..1 | ||||||||||||
Type | Choice of: positiveInt, string | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Comments | The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose). | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
1. 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 | ||||||||||||
Control | 0..* | ||||||||||||
2. Immunization.id | |||||||||||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | id | ||||||||||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||||||||||
3. Immunization.meta | |||||||||||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Meta | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
4. Immunization.implicitRules | |||||||||||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | uri | ||||||||||||
Is Modifier | true | ||||||||||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
5. Immunization.language | |||||||||||||
Definition | The base language in which the resource is written. | ||||||||||||
Control | 0..1 | ||||||||||||
Binding | The codes SHOULD be taken from CommonLanguages
A human language
| ||||||||||||
Type | code | ||||||||||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
6. Immunization.text | |||||||||||||
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Narrative | ||||||||||||
Alternate Names | narrativehtmlxhtmldisplay | ||||||||||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
7. Immunization.contained | |||||||||||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||||||||||
Control | 0..* | ||||||||||||
Type | Resource | ||||||||||||
Alternate Names | inline resourcesanonymous resourcescontained resources | ||||||||||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||||||||||
8. Immunization.extension | |||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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. | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensionsuser content | ||||||||||||
Comments | 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. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
9. Immunization.modifierExtension | |||||||||||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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). | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true | ||||||||||||
Requirements | 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. | ||||||||||||
Alternate Names | extensionsuser content | ||||||||||||
Comments | 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. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
10. Immunization.identifier | |||||||||||||
Definition | A unique identifier assigned to this immunization record. | ||||||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||||||
Control | 0..* | ||||||||||||
Type | Identifier | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
11. Immunization.status | |||||||||||||
Definition | Indicates the current status of the immunization event. | ||||||||||||
Control | 1..1 | ||||||||||||
Binding | The codes SHALL be taken from ImmunizationStatusCodes A set of codes indicating the current status of an Immunization | ||||||||||||
Type | code | ||||||||||||
Is Modifier | true | ||||||||||||
Must Support | true | ||||||||||||
Comments | Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
12. Immunization.statusReason | |||||||||||||
Definition | Indicates the reason the immunization event was not performed. | ||||||||||||
Control | 0..1 | ||||||||||||
Binding | For example codes, see ImmunizationStatusReasonCodes The reason why a vaccine was not administered | ||||||||||||
Type | CodeableConcept | ||||||||||||
Comments | This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
13. Immunization.vaccineCode | |||||||||||||
Definition | Vaccine 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 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. | ||||||||||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Binding | The codes SHOULD be taken from Vaccines - IPS
The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization
| ||||||||||||
Type | CodeableConcept(CodeableConceptIPS) | ||||||||||||
Must Support | true | ||||||||||||
Comments | 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. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
14. Immunization.patient | |||||||||||||
Definition | The patient who either received or did not receive the immunization. | ||||||||||||
Control | 1..1 | ||||||||||||
Type | Reference(PatientUvIps)) | ||||||||||||
Must Support | true | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
15. Immunization.patient.id | |||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||||||||||
16. Immunization.patient.extension | |||||||||||||
Definition | May 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. | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensionsuser content | ||||||||||||
Comments | 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. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
Slicing | This element introduces a set of slices on Immunization.patient.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||||||||||
17. Immunization.patient.reference | |||||||||||||
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||||||||||
Control | 1..1 This element is affected by the following invariants: ref-1 | ||||||||||||
Type | string | ||||||||||||
Must Support | true | ||||||||||||
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
18. Immunization.patient.type | |||||||||||||
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||||||||||
Control | 0..1 | ||||||||||||
Binding | The codes SHALL be taken from ResourceType; other codes may be used where these codes are not suitable Aa resource (or, for logical models, the URI of the logical model) | ||||||||||||
Type | uri | ||||||||||||
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
19. Immunization.patient.identifier | |||||||||||||
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Identifier | ||||||||||||
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
20. Immunization.patient.display | |||||||||||||
Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
21. Immunization.encounter | |||||||||||||
Definition | The visit or admission or other contact between patient and health care provider the immunization was performed as part of. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Reference(Encounter)) | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
22. Immunization.occurrence[x] | |||||||||||||
Definition | Date vaccine administered or was to be administered. | ||||||||||||
Control | 1..1 | ||||||||||||
Type | Choice of: dateTime, string | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Must Support | true | ||||||||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||||||||
Comments | When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
23. Immunization.occurrence[x].id | |||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||||||||||
24. Immunization.occurrence[x].extension | |||||||||||||
Definition | May 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. | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensionsuser content | ||||||||||||
Comments | 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. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
Slicing | This element introduces a set of slices on Immunization.occurrence[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||||||||||
25. Immunization.occurrence[x].extension:data-absent-reason | |||||||||||||
SliceName | data-absent-reason | ||||||||||||
Definition | Provides a reason why the occurrence is missing. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Extension(Data Absent Reason) (Extension Type: code) | ||||||||||||
Must Support | true | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
26. Immunization.recorded | |||||||||||||
Definition | The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | dateTime | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
27. Immunization.primarySource | |||||||||||||
Definition | An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | boolean | ||||||||||||
Comments | Reflects the “reliability” of the content. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
28. Immunization.reportOrigin | |||||||||||||
Definition | The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine. | ||||||||||||
Control | 0..1 | ||||||||||||
Binding | For example codes, see ImmunizationOriginCodes The source of the data for a record which is not from a primary source | ||||||||||||
Type | CodeableConcept | ||||||||||||
Comments | Should not be populated if primarySource = True, not required even if primarySource = False. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
29. Immunization.location | |||||||||||||
Definition | The service delivery location where the vaccine administration occurred. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Reference(Location)) | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
30. Immunization.manufacturer | |||||||||||||
Definition | Name of vaccine manufacturer. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Reference(Organization)) | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
31. Immunization.lotNumber | |||||||||||||
Definition | Lot number of the vaccine product. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
32. Immunization.expirationDate | |||||||||||||
Definition | Date vaccine batch expires. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | date | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
33. Immunization.site | |||||||||||||
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | ||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Binding | The codes SHOULD be taken from SNOMEDCTBodyStructures | ||||||||||||
Type | CodeableConcept(CodeableConceptIPS) | ||||||||||||
Comments | 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. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
34. Immunization.route | |||||||||||||
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. | ||||||||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||||||||
Binding | The codes SHOULD be taken from Medicine Route of Administration - IPS | ||||||||||||
Type | CodeableConcept(CodeableConceptIPS) | ||||||||||||
Comments | 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. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
35. Immunization.doseQuantity | |||||||||||||
Definition | The quantity of vaccine product that was administered. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Quantity(SimpleQuantity) | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
36. Immunization.performer | |||||||||||||
Definition | Indicates who performed the immunization event. | ||||||||||||
Control | 0..* | ||||||||||||
Type | BackboneElement | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
37. Immunization.performer.id | |||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||||||||||
38. Immunization.performer.extension | |||||||||||||
Definition | May 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. | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensionsuser content | ||||||||||||
Comments | 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. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
39. Immunization.performer.modifierExtension | |||||||||||||
Definition | May 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). | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true | ||||||||||||
Requirements | 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. | ||||||||||||
Alternate Names | extensionsuser contentmodifiers | ||||||||||||
Comments | 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. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
40. Immunization.performer.function | |||||||||||||
Definition | Describes the type of performance (e.g. ordering provider, administering provider, etc.). | ||||||||||||
Control | 0..1 | ||||||||||||
Binding | The codes SHALL be taken from ImmunizationFunctionCodes; other codes may be used where these codes are not suitable The role a practitioner or organization plays in the immunization event | ||||||||||||
Type | CodeableConcept | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
41. Immunization.performer.actor | |||||||||||||
Definition | The practitioner or organization who performed the action. | ||||||||||||
Control | 1..1 | ||||||||||||
Type | Reference(PractitionerPractitionerRoleOrganization)) | ||||||||||||
Comments | When the individual practitioner who performed the action is known, it is best to send. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
42. Immunization.note | |||||||||||||
Definition | Extra information about the immunization that is not conveyed by the other attributes. | ||||||||||||
Control | 0..* | ||||||||||||
Type | Annotation | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
43. Immunization.reasonCode | |||||||||||||
Definition | Reasons why the vaccine was administered. | ||||||||||||
Control | 0..* | ||||||||||||
Binding | For example codes, see ImmunizationReasonCodes The reason why a vaccine was administered | ||||||||||||
Type | CodeableConcept | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
44. Immunization.reasonReference | |||||||||||||
Definition | Condition, Observation or DiagnosticReport that supports why the immunization was administered. | ||||||||||||
Control | 0..* | ||||||||||||
Type | Reference(ConditionObservationDiagnosticReport)) | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
45. Immunization.isSubpotent | |||||||||||||
Definition | Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | boolean | ||||||||||||
Is Modifier | true | ||||||||||||
Comments | Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event. | ||||||||||||
Meaning if Missing | By default, a dose should be considered to be potent. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
46. Immunization.subpotentReason | |||||||||||||
Definition | Reason why a dose is considered to be subpotent. | ||||||||||||
Control | 0..* | ||||||||||||
Binding | For example codes, see ImmunizationSubpotentReason The reason why a dose is considered to be subpotent | ||||||||||||
Type | CodeableConcept | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
47. Immunization.education | |||||||||||||
Definition | Educational material presented to the patient (or guardian) at the time of vaccine administration. | ||||||||||||
Control | 0..* | ||||||||||||
Type | BackboneElement | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) imm-1: One of documentType or reference SHALL be present (: documentType.exists() or reference.exists()) | ||||||||||||
48. Immunization.education.id | |||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||||||||||
49. Immunization.education.extension | |||||||||||||
Definition | May 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. | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensionsuser content | ||||||||||||
Comments | 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. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
50. Immunization.education.modifierExtension | |||||||||||||
Definition | May 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). | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true | ||||||||||||
Requirements | 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. | ||||||||||||
Alternate Names | extensionsuser contentmodifiers | ||||||||||||
Comments | 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. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
51. Immunization.education.documentType | |||||||||||||
Definition | Identifier of the material presented to the patient. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
52. Immunization.education.reference | |||||||||||||
Definition | Reference pointer to the educational material given to the patient if the information was on line. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | uri | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
53. Immunization.education.publicationDate | |||||||||||||
Definition | Date the educational material was published. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | dateTime | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
54. Immunization.education.presentationDate | |||||||||||||
Definition | Date the educational material was given to the patient. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | dateTime | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
55. Immunization.programEligibility | |||||||||||||
Definition | Indicates a patient's eligibility for a funding program. | ||||||||||||
Control | 0..* | ||||||||||||
Binding | For example codes, see ImmunizationProgramEligibility The patient's eligibility for a vaccation program | ||||||||||||
Type | CodeableConcept | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
56. Immunization.fundingSource | |||||||||||||
Definition | Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered). | ||||||||||||
Control | 0..1 | ||||||||||||
Binding | For example codes, see ImmunizationFundingSource The source of funding used to purchase the vaccine administered | ||||||||||||
Type | CodeableConcept | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
57. Immunization.reaction | |||||||||||||
Definition | Categorical data indicating that an adverse event is associated in time to an immunization. | ||||||||||||
Control | 0..* | ||||||||||||
Type | BackboneElement | ||||||||||||
Comments | A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
58. Immunization.reaction.id | |||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||||||||||
59. Immunization.reaction.extension | |||||||||||||
Definition | May 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. | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensionsuser content | ||||||||||||
Comments | 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. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
60. Immunization.reaction.modifierExtension | |||||||||||||
Definition | May 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). | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true | ||||||||||||
Requirements | 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. | ||||||||||||
Alternate Names | extensionsuser contentmodifiers | ||||||||||||
Comments | 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. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
61. Immunization.reaction.date | |||||||||||||
Definition | Date of reaction to the immunization. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | dateTime | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
62. Immunization.reaction.detail | |||||||||||||
Definition | Details of the reaction. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Reference(Observation)) | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
63. Immunization.reaction.reported | |||||||||||||
Definition | Self-reported indicator. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | boolean | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
64. Immunization.protocolApplied | |||||||||||||
Definition | The protocol (set of recommendations) being followed by the provider who administered the dose. | ||||||||||||
Control | 0..* | ||||||||||||
Type | BackboneElement | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
65. Immunization.protocolApplied.id | |||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||||||||||
66. Immunization.protocolApplied.extension | |||||||||||||
Definition | May 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. | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensionsuser content | ||||||||||||
Comments | 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. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
67. Immunization.protocolApplied.modifierExtension | |||||||||||||
Definition | May 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). | ||||||||||||
Control | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Is Modifier | true | ||||||||||||
Requirements | 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. | ||||||||||||
Alternate Names | extensionsuser contentmodifiers | ||||||||||||
Comments | 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. | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||||||||||
68. Immunization.protocolApplied.series | |||||||||||||
Definition | One possible path to achieve presumed immunity against a disease - within the context of an authority. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | string | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
69. Immunization.protocolApplied.authority | |||||||||||||
Definition | Indicates the authority who published the protocol (e.g. ACIP) that is being followed. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Reference(Organization)) | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
70. Immunization.protocolApplied.targetDisease | |||||||||||||
Definition | The particular disease against which the patient has been immunized. Additional conformance bindings provided for use for this element in specific (jurisdictional or other) contexts include (these bindings are represented in the StructureDefinition as instances of the elementdefinition-additionalBinding extension): | ||||||||||||
Control | 0..* | ||||||||||||
Binding | The codes SHOULD be taken from Vaccine Target Diseases - IPS
The particular disease or diseases against which the patient has been immunized
| ||||||||||||
Type | CodeableConcept | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
71. Immunization.protocolApplied.doseNumber[x] | |||||||||||||
Definition | Nominal position in a series. | ||||||||||||
Control | 1..1 | ||||||||||||
Type | Choice of: positiveInt, string | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Comments | The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose). | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||||||||||
72. Immunization.protocolApplied.seriesDoses[x] | |||||||||||||
Definition | The recommended number of doses to achieve immunity. | ||||||||||||
Control | 0..1 | ||||||||||||
Type | Choice of: positiveInt, string | ||||||||||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||||||||||
Comments | The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose). | ||||||||||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |