OpenMRS Core FHIR Implementation Guide
0.1.0 - ci-build
OpenMRS Core FHIR Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
Active as of 2023-06-23 |
Definitions for the omrs-immunization resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. Immunization | |
2. Immunization.id | |
Control | 10..1 |
3. Immunization.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..0* |
4. Immunization.status | |
5. Immunization.statusReason | |
Control | 0..01 |
6. Immunization.vaccineCode | |
7. Immunization.patient | |
Type | Reference(OMRSPatient|Patient) |
8. Immunization.encounter | |
Type | Reference(OMRSEncounter|Encounter) |
9. Immunization.occurrence[x] | |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Slicing | This element introduces a set of slices on Immunization.occurrence[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
10. Immunization.occurrence[x]:occurrenceDateTime | |
SliceName | occurrenceDateTime |
Control | 0..1 |
Type | dateTime |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
11. Immunization.recorded | |
Control | 0..01 |
12. Immunization.primarySource | |
Control | 0..01 |
13. Immunization.reportOrigin | |
Control | 0..01 |
14. Immunization.location | |
Type | Reference(OMRSLocation|Location) |
15. Immunization.manufacturer | |
16. Immunization.lotNumber | |
17. Immunization.expirationDate | |
18. Immunization.site | |
Control | 0..01 |
19. Immunization.route | |
Control | 0..01 |
20. Immunization.doseQuantity | |
Control | 0..01 |
21. Immunization.performer | |
Control | 0..? |
22. Immunization.performer.function | |
Control | 0..01 |
23. Immunization.performer.actor | |
Type | Reference(OMRSPractitioner|Practitioner|PractitionerRole|Organization) |
24. Immunization.note | |
Control | 0..0* |
25. Immunization.reasonCode | |
Control | 0..0* |
26. Immunization.reasonReference | |
Control | 0..0* |
27. Immunization.isSubpotent | |
Control | 0..01 |
28. Immunization.education | |
Control | 0..0* |
29. Immunization.programEligibility | |
Control | 0..0* |
30. Immunization.fundingSource | |
Control | 0..01 |
31. Immunization.reaction | |
Control | 0..0* |
32. Immunization.protocolApplied | |
Control | 0..1* |
33. Immunization.protocolApplied.doseNumber[x] | |
[x] Note | See Choice of Data Types for further information about how to use [x] |
34. Immunization.protocolApplied.seriesDoses[x] | |
Control | 0..01 |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Guidance on how to interpret the contents of this table can be found here.
1. Immunization | |
Definition | 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..* |
Summary | false |
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.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 10..1 |
Type | idstring |
Summary | true |
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.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 |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | 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())) |
4. 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 |
Summary | false |
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()) |
5. 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..0* |
Type | Identifier |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
6. 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 |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | 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())) |
7. Immunization.statusReason | |
Definition | Indicates the reason the immunization event was not performed. |
Control | 0..01 |
Binding | For example codes, see ImmunizationStatusReasonCodes The reason why a vaccine was not administered. |
Type | CodeableConcept |
Summary | false |
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())) |
8. Immunization.vaccineCode | |
Definition | Vaccine that was administered or was to be administered. |
Control | 1..1 |
Binding | For example codes, see VaccineAdministeredValueSet The code for vaccine product administered. |
Type | CodeableConcept |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
9. Immunization.patient | |
Definition | The patient who either received or did not receive the immunization. |
Control | 1..1 |
Type | Reference(OMRSPatient|Patient) |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
10. 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(OMRSEncounter|Encounter) |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
11. 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] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
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())) |
Slicing | This element introduces a set of slices on Immunization.occurrence[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
12. Immunization.occurrence[x]:occurrenceDateTime | |
SliceName | occurrenceDateTime |
Definition | Date vaccine administered or was to be administered. |
Control | 01..1 |
Type | Choice of: dateTime, string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
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())) |
13. 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..01 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
14. 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..01 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
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())) |
15. 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..01 |
Binding | For example codes, see ImmunizationOriginCodes The source of the data for a record which is not from a primary source. |
Type | CodeableConcept |
Summary | false |
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())) |
16. Immunization.location | |
Definition | The service delivery location where the vaccine administration occurred. |
Control | 0..1 |
Type | Reference(OMRSLocation|Location) |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
17. Immunization.manufacturer | |
Definition | Name of vaccine manufacturer. |
Control | 0..1 |
Type | Reference(Organization) |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
18. Immunization.lotNumber | |
Definition | Lot number of the vaccine product. |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
19. Immunization.expirationDate | |
Definition | Date vaccine batch expires. |
Control | 0..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
20. Immunization.site | |
Definition | Body site where vaccine was administered. |
Control | 0..01 |
Binding | For example codes, see CodesForImmunizationSiteOfAdministration The site at which the vaccine was administered. |
Type | CodeableConcept |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
21. Immunization.route | |
Definition | The path by which the vaccine product is taken into the body. |
Control | 0..01 |
Binding | For example codes, see ImmunizationRouteCodes The route by which the vaccine was administered. |
Type | CodeableConcept |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
22. Immunization.doseQuantity | |
Definition | The quantity of vaccine product that was administered. |
Control | 0..01 |
Type | Quantity(SimpleQuantity) |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
23. Immunization.note | |
Definition | Extra information about the immunization that is not conveyed by the other attributes. |
Control | 0..0* |
Type | Annotation |
Summary | true |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
24. Immunization.reasonCode | |
Definition | Reasons why the vaccine was administered. |
Control | 0..0* |
Binding | For example codes, see ImmunizationReasonCodes The reason why a vaccine was administered. |
Type | CodeableConcept |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
25. Immunization.reasonReference | |
Definition | Condition, Observation or DiagnosticReport that supports why the immunization was administered. |
Control | 0..0* |
Type | Reference(Condition|Observation|DiagnosticReport) |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
26. Immunization.isSubpotent | |
Definition | Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent. |
Control | 0..01 |
Type | boolean |
Is Modifier | true |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | 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())) |
27. Immunization.education | |
Definition | Educational material presented to the patient (or guardian) at the time of vaccine administration. |
Control | 0..0* |
Type | BackboneElement |
Summary | false |
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()) |
28. Immunization.programEligibility | |
Definition | Indicates a patient's eligibility for a funding program. |
Control | 0..0* |
Binding | For example codes, see ImmunizationProgramEligibility The patient's eligibility for a vaccation program. |
Type | CodeableConcept |
Summary | 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.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..01 |
Binding | For example codes, see ImmunizationFundingSource The source of funding used to purchase the vaccine administered. |
Type | CodeableConcept |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
30. Immunization.reaction | |
Definition | Categorical data indicating that an adverse event is associated in time to an immunization. |
Control | 0..0* |
Type | BackboneElement |
Summary | false |
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())) |
31. Immunization.protocolApplied | |
Definition | The protocol (set of recommendations) being followed by the provider who administered the dose. |
Control | 0..1* |
Type | BackboneElement |
Summary | false |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
32. 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 |
Summary | 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()) |
33. 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] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
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())) |
34. Immunization.protocolApplied.seriesDoses[x] | |
Definition | The recommended number of doses to achieve immunity. |
Control | 0..01 |
Type | Choice of: positiveInt, string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | false |
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())) |
Guidance on how to interpret the contents of this table can be found here.
1. Immunization | |||||
Definition | 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..* | ||||
Summary | false | ||||
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 | 1..1 | ||||
Type | id | ||||
Summary | true | ||||
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 | ||||
Summary | true | ||||
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 | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | 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 | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
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 | ||||
Summary | false | ||||
Alternate Names | narrative, html, xhtml, display | ||||
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 | ||||
Summary | false | ||||
Alternate Names | inline resources, anonymous resources, contained 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 | ||||
Summary | false | ||||
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()) | ||||
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 | ||||
Summary | false | ||||
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()) | ||||
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..0 | ||||
Type | Identifier | ||||
Summary | false | ||||
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 | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | 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..0 | ||||
Binding | For example codes, see ImmunizationStatusReasonCodes The reason why a vaccine was not administered | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
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. | ||||
Control | 1..1 | ||||
Binding | For example codes, see VaccineAdministeredValueSet The code for vaccine product administered | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
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(OMRSPatient) | ||||
Summary | 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.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(OMRSEncounter) | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
16. 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] | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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())) | ||||
Slicing | This element introduces a set of slices on Immunization.occurrence[x]. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
17. Immunization.occurrence[x]:occurrenceDateTime | |||||
SliceName | occurrenceDateTime | ||||
Definition | Date vaccine administered or was to be administered. | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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())) | ||||
18. 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..0 | ||||
Type | dateTime | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
19. 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..0 | ||||
Type | boolean | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
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())) | ||||
20. 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..0 | ||||
Binding | For example codes, see ImmunizationOriginCodes The source of the data for a record which is not from a primary source | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
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())) | ||||
21. Immunization.location | |||||
Definition | The service delivery location where the vaccine administration occurred. | ||||
Control | 0..1 | ||||
Type | Reference(OMRSLocation) | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
22. Immunization.manufacturer | |||||
Definition | Name of vaccine manufacturer. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
23. Immunization.lotNumber | |||||
Definition | Lot number of the vaccine product. | ||||
Control | 0..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
24. Immunization.expirationDate | |||||
Definition | Date vaccine batch expires. | ||||
Control | 0..1 | ||||
Type | date | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
25. Immunization.site | |||||
Definition | Body site where vaccine was administered. | ||||
Control | 0..0 | ||||
Binding | For example codes, see CodesForImmunizationSiteOfAdministration The site at which the vaccine was administered | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
26. Immunization.route | |||||
Definition | The path by which the vaccine product is taken into the body. | ||||
Control | 0..0 | ||||
Binding | For example codes, see ImmunizationRouteCodes The route by which the vaccine was administered | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
27. Immunization.doseQuantity | |||||
Definition | The quantity of vaccine product that was administered. | ||||
Control | 0..0 | ||||
Type | Quantity(SimpleQuantity) | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
28. Immunization.performer | |||||
Definition | Indicates who performed the immunization event. | ||||
Control | 0..* | ||||
Type | BackboneElement | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
29. 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. | ||||
Summary | false | ||||
30. 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 | ||||
Summary | false | ||||
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()) | ||||
31. 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 | ||||
Summary | 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()) | ||||
32. Immunization.performer.function | |||||
Definition | Describes the type of performance (e.g. ordering provider, administering provider, etc.). | ||||
Control | 0..0 | ||||
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 | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
33. Immunization.performer.actor | |||||
Definition | The practitioner or organization who performed the action. | ||||
Control | 1..1 | ||||
Type | Reference(OMRSPractitioner) | ||||
Summary | true | ||||
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())) | ||||
34. Immunization.note | |||||
Definition | Extra information about the immunization that is not conveyed by the other attributes. | ||||
Control | 0..0 | ||||
Type | Annotation | ||||
Summary | true | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
35. Immunization.reasonCode | |||||
Definition | Reasons why the vaccine was administered. | ||||
Control | 0..0 | ||||
Binding | For example codes, see ImmunizationReasonCodes The reason why a vaccine was administered | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
36. Immunization.reasonReference | |||||
Definition | Condition, Observation or DiagnosticReport that supports why the immunization was administered. | ||||
Control | 0..0 | ||||
Type | Reference(Condition|Observation|DiagnosticReport) | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
37. Immunization.isSubpotent | |||||
Definition | Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent. | ||||
Control | 0..0 | ||||
Type | boolean | ||||
Is Modifier | true | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | 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())) | ||||
38. 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 | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
39. Immunization.education | |||||
Definition | Educational material presented to the patient (or guardian) at the time of vaccine administration. | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Summary | false | ||||
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()) | ||||
40. Immunization.programEligibility | |||||
Definition | Indicates a patient's eligibility for a funding program. | ||||
Control | 0..0 | ||||
Binding | For example codes, see ImmunizationProgramEligibility The patient's eligibility for a vaccation program | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
41. 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..0 | ||||
Binding | For example codes, see ImmunizationFundingSource The source of funding used to purchase the vaccine administered | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
42. Immunization.reaction | |||||
Definition | Categorical data indicating that an adverse event is associated in time to an immunization. | ||||
Control | 0..0 | ||||
Type | BackboneElement | ||||
Summary | false | ||||
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())) | ||||
43. Immunization.protocolApplied | |||||
Definition | The protocol (set of recommendations) being followed by the provider who administered the dose. | ||||
Control | 0..1 | ||||
Type | BackboneElement | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
44. 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. | ||||
Summary | false | ||||
45. 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 | ||||
Summary | false | ||||
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()) | ||||
46. 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 | ||||
Summary | 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()) | ||||
47. 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 | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
48. Immunization.protocolApplied.authority | |||||
Definition | Indicates the authority who published the protocol (e.g. ACIP) that is being followed. | ||||
Control | 0..1 | ||||
Type | Reference(Organization) | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
49. Immunization.protocolApplied.targetDisease | |||||
Definition | The vaccine preventable disease the dose is being administered against. | ||||
Control | 0..* | ||||
Binding | For example codes, see ImmunizationTargetDiseaseCodes The vaccine preventable disease the dose is being administered for | ||||
Type | CodeableConcept | ||||
Summary | false | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
50. 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] | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
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())) | ||||
51. Immunization.protocolApplied.seriesDoses[x] | |||||
Definition | The recommended number of doses to achieve immunity. | ||||
Control | 0..0 | ||||
Type | Choice of: positiveInt, string | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | false | ||||
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())) |