HL7 FHIR JP Core ImplementationGuide
1.1.1 - release Japan flag

HL7 FHIR JP Core ImplementationGuide - Local Development build (v1.1.1). See the Directory of published versions

Resource Profile: JP_Immunization - Detailed Descriptions

Active as of 2022-10-24

Definitions for the jp-immunization resource profile.

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.

2. Immunization.id
3. Immunization.extension
SlicingThis element introduces a set of slices on Immunization.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Immunization.extension:dueDateOfNextDose
SliceNamedueDateOfNextDose
Control0..1
TypeExtension(JP_Immunization_DueDateOfNextDose) (Extension Type: date)
5. Immunization.extension:manufacturedDate
SliceNamemanufacturedDate
Control0..1
TypeExtension(JP_Immunization_ManufacturedDate) (Extension Type: date)
6. Immunization.extension:certificatedDate
SliceNamecertificatedDate
Control0..1
TypeExtension(JP_Immunization_CertificatedDate) (Extension Type: date)
7. Immunization.status
Definition

予防接種記録の現在の状態を示すコード

Indicates the current status of the immunization event.

Binding

予防接種の現在の状態を表すコード

A set of codes indicating the current status of an Immunization.

8. Immunization.statusReason
9. Immunization.vaccineCode
Definition

接種されたあるいは接種予定のワクチン。

Vaccine that was administered or was to be administered.

BindingThe codes SHOULD be taken from JP Core MedicationCode Immunization ValueSetFor example codes, see VaccineAdministeredValueSet
Comments

全てのターミノロジがこのパターンに当てはまるわけではない。モデルによってはCodeableConceptではなく,独自構造でCodingを直接指定して文書やコーディング,その解釈や事前条件や事後条件との関連について示される。

10. Immunization.patient
Definition

予防接種を受けた,あるいは受けなかった患者。

The patient who either received or did not receive the immunization.

TypeReference(JP_Patient|Patient))
11. Immunization.encounter
Definition

患者が医療従事者から予防接種を受けた外来,入院あるいは他の対面の状態を表す。

The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

TypeReference(JP_Encounter|Encounter))
12. Immunization.occurrence[x]
Definition

ワクチンを接種した日あるいは接種予定だった日。

Date vaccine administered or was to be administered.

[x] NoteSee Choice of Data Types for further information about how to use [x]
13. Immunization.recorded
14. 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.

15. Immunization.location
Definition

接種医療機関。ワクチン接種がどこで実施されたかを表す。サービスが提供された場所。摂取された身体部位ではない。

The service delivery location where the vaccine administration occurred.

TypeReference(JP_Location|Location))
16. Immunization.manufacturer
Definition

ワクチメーカーの名前。

Name of vaccine manufacturer.

TypeReference(JP_Organization|Organization))
17. Immunization.lotNumber
Definition

ワクチン製剤のロット番号。

Lot number of the vaccine product.

18. Immunization.expirationDate
Definition

ワクチンの消費期限を表す日。

Date vaccine batch expires.

19. Immunization.site
Definition

ワクチンが接種された身体部位

Body site where vaccine was administered.

20. Immunization.route
Definition

ワクチンが体内へと接種された経路。

The path by which the vaccine product is taken into the body.

21. Immunization.doseQuantity
Definition

ワクチン製剤が接種された量

The quantity of vaccine product that was administered.

TypeQuantity(JP_MedicationSimpleQuantity, SimpleQuantity)
22. Immunization.performer
Definition

誰が予防接種を実施したかを表す。

Indicates who performed the immunization event.

23. Immunization.performer.actor
TypeReference(JP_Practitioner|JP_PractitionerRole|JP_Organization|Practitioner|PractitionerRole|Organization))
24. Immunization.note
Definition

他の属性で伝達することができない予防接種に関する他の記録。

Extra information about the immunization that is not conveyed by the other attributes.

25. Immunization.reasonCode
Definition

予防接種が行われた理由

Reasons why the vaccine was administered.

26. Immunization.reasonReference
Definition

予防接種が実施された理由を表すCondition,ObservationあるいはDiagnosticReportリソースを参照する。

Condition, Observation or DiagnosticReport that supports why the immunization was administered.

27. Immunization.isSubpotent
Definition

量が通常の効力より弱いと考えられているかどうかを示す。デフォルトでは示されている量と同等の効力をもつと考えられている。

Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.

28. Immunization.subpotentReason
Definition

効力が減弱すると考えられている理由。

Reason why a dose is considered to be subpotent.

29. Immunization.education
Definition

ワクチンを接種するときに患者(あるいは保護者)に提示された教材。

Educational material presented to the patient (or guardian) at the time of vaccine administration.

30. Immunization.programEligibility
Definition

ワクチン接種計画での患者適格性を示す

Indicates a patient's eligibility for a funding program.

31. 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).

32. Immunization.reaction
Definition

予防接種に関連する時期に発生した副反応を示す分類されたデータ。

Categorical data indicating that an adverse event is associated in time to an immunization.

33. Immunization.protocolApplied
Definition

ワクチンを接種した提供者が実施したプロトコール(推奨される手順の集合)。

The protocol (set of recommendations) being followed by the provider who administered the dose.

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.

Control0..*
InvariantsDefined 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.

Control0..1
Typeidstring
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.

Control0..1
Typeuri
Is Modifiertrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. Immunization.extension
Definition

An Extension

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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

InvariantsDefined 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())
SlicingThis element introduces a set of slices on Immunization.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
5. Immunization.extension:dueDateOfNextDose
SliceNamedueDateOfNextDose
Definition

次回接種を予定している日、期限

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(JP_Immunization_DueDateOfNextDose) (Extension Type: date)
InvariantsDefined 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())
6. Immunization.extension:manufacturedDate
SliceNamemanufacturedDate
Definition

ワクチンが製造された年月日

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(JP_Immunization_ManufacturedDate) (Extension Type: date)
InvariantsDefined 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())
7. Immunization.extension:certificatedDate
SliceNamecertificatedDate
Definition

ワクチンが検定された年月日

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(JP_Immunization_CertificatedDate) (Extension Type: date)
InvariantsDefined 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())
8. 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).

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensions, 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.

InvariantsDefined 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.status
Definition

予防接種記録の現在の状態を示すコード

Indicates the current status of the immunization event.

Control1..1
BindingThe codes SHALL be taken from ImmunizationStatusCodes

予防接種の現在の状態を表すコード

A set of codes indicating the current status of an Immunization.

Typecode
Is Modifiertrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. Immunization.statusReason
Definition

Indicates the reason the immunization event was not performed.

Control0..1
BindingFor example codes, see ImmunizationStatusReasonCodes

The reason why a vaccine was not administered.

TypeCodeableConcept
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. Immunization.vaccineCode
Definition

接種されたあるいは接種予定のワクチン。

Vaccine that was administered or was to be administered.

Control1..1
BindingThe codes SHOULD be taken from JP Core MedicationCode Immunization ValueSetFor example codes, see VaccineAdministeredValueSet
TypeCodeableConcept
Comments

全てのターミノロジがこのパターンに当てはまるわけではない。モデルによってはCodeableConceptではなく,独自構造でCodingを直接指定して文書やコーディング,その解釈や事前条件や事後条件との関連について示される。

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. Immunization.patient
Definition

予防接種を受けた,あるいは受けなかった患者。

The patient who either received or did not receive the immunization.

Control1..1
TypeReference(JP_Patient|Patient))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Immunization.encounter
Definition

患者が医療従事者から予防接種を受けた外来,入院あるいは他の対面の状態を表す。

The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

Control0..1
TypeReference(JP_Encounter|Encounter))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Immunization.occurrence[x]
Definition

ワクチンを接種した日あるいは接種予定だった日。

Date vaccine administered or was to be administered.

Control1..1
TypeChoice of: dateTime, string
[x] NoteSee Choice of Data Types for further information about how to use [x]
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Immunization.recorded
Definition

The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.

Control0..1
TypedateTime
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. 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.

Control0..1
BindingFor example codes, see ImmunizationOriginCodes

The source of the data for a record which is not from a primary source.

TypeCodeableConcept
Comments

Should not be populated if primarySource = True, not required even if primarySource = False.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Immunization.location
Definition

接種医療機関。ワクチン接種がどこで実施されたかを表す。サービスが提供された場所。摂取された身体部位ではない。

The service delivery location where the vaccine administration occurred.

Control0..1
TypeReference(JP_Location|Location))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. Immunization.manufacturer
Definition

ワクチメーカーの名前。

Name of vaccine manufacturer.

Control0..1
TypeReference(JP_Organization|Organization))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Immunization.lotNumber
Definition

ワクチン製剤のロット番号。

Lot number of the vaccine product.

Control0..1
Typestring
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. Immunization.expirationDate
Definition

ワクチンの消費期限を表す日。

Date vaccine batch expires.

Control0..1
Typedate
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. Immunization.site
Definition

ワクチンが接種された身体部位

Body site where vaccine was administered.

Control0..1
BindingFor example codes, see CodesForImmunizationSiteOfAdministration

The site at which the vaccine was administered.

TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Immunization.route
Definition

ワクチンが体内へと接種された経路。

The path by which the vaccine product is taken into the body.

Control0..1
BindingFor example codes, see ImmunizationRouteCodes

The route by which the vaccine was administered.

TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. Immunization.doseQuantity
Definition

ワクチン製剤が接種された量

The quantity of vaccine product that was administered.

Control0..1 This element is affected by the following invariants: ele-1
TypeQuantity(JP_MedicationSimpleQuantity, SimpleQuantity)
Comments

薬剤に関する簡易的な数量と単位を定めている。ValueおよびCodeを必須とし、comparatorは記述不可。単位についてはMERIT9医薬品単位略号の利用を推進している。(SHOULD)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
qty-3: If a code for the unit is present, the system SHALL also be present (: code.empty() or system.exists())
sqty-1: The comparator is not used on a SimpleQuantity (: comparator.empty())
24. Immunization.performer
Definition

誰が予防接種を実施したかを表す。

Indicates who performed the immunization event.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. 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).

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensions, 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.

InvariantsDefined 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.performer.actor
Definition

The practitioner or organization who performed the action.

Control1..1
TypeReference(JP_Practitioner|JP_PractitionerRole|JP_Organization|Practitioner|PractitionerRole|Organization))
Comments

When the individual practitioner who performed the action is known, it is best to send.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. Immunization.note
Definition

他の属性で伝達することができない予防接種に関する他の記録。

Extra information about the immunization that is not conveyed by the other attributes.

Control0..*
TypeAnnotation
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. Immunization.reasonCode
Definition

予防接種が行われた理由

Reasons why the vaccine was administered.

Control0..*
BindingFor example codes, see ImmunizationReasonCodes

The reason why a vaccine was administered.

TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Immunization.reasonReference
Definition

予防接種が実施された理由を表すCondition,ObservationあるいはDiagnosticReportリソースを参照する。

Condition, Observation or DiagnosticReport that supports why the immunization was administered.

Control0..*
TypeReference(Condition|Observation|DiagnosticReport))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. Immunization.isSubpotent
Definition

量が通常の効力より弱いと考えられているかどうかを示す。デフォルトでは示されている量と同等の効力をもつと考えられている。

Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.

Control0..1
Typeboolean
Is Modifiertrue
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 MissingBy default, a dose should be considered to be potent.
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. Immunization.subpotentReason
Definition

効力が減弱すると考えられている理由。

Reason why a dose is considered to be subpotent.

Control0..*
BindingFor example codes, see ImmunizationSubpotentReason

The reason why a dose is considered to be subpotent.

TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. Immunization.education
Definition

ワクチンを接種するときに患者(あるいは保護者)に提示された教材。

Educational material presented to the patient (or guardian) at the time of vaccine administration.

Control0..*
TypeBackboneElement
InvariantsDefined 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())
33. 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).

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensions, 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.

InvariantsDefined 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())
34. Immunization.programEligibility
Definition

ワクチン接種計画での患者適格性を示す

Indicates a patient's eligibility for a funding program.

Control0..*
BindingFor example codes, see ImmunizationProgramEligibility

The patient's eligibility for a vaccation program.

TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. 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).

Control0..1
BindingFor example codes, see ImmunizationFundingSource

The source of funding used to purchase the vaccine administered.

TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. Immunization.reaction
Definition

予防接種に関連する時期に発生した副反応を示す分類されたデータ。

Categorical data indicating that an adverse event is associated in time to an immunization.

Control0..*
TypeBackboneElement
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. 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).

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensions, 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.

InvariantsDefined 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())
38. Immunization.protocolApplied
Definition

ワクチンを接種した提供者が実施したプロトコール(推奨される手順の集合)。

The protocol (set of recommendations) being followed by the provider who administered the dose.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. 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).

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensions, 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.

InvariantsDefined 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.protocolApplied.doseNumber[x]
Definition

Nominal position in a series.

Control1..1
TypeChoice of: positiveInt, string
[x] NoteSee 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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1. Immunization
Definition

ワクチンを接種したときの記録,あるいは予防接種について患者や医療従事者などが報告した記録。

Control0..*
2. Immunization.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
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.

Control0..1
TypeMeta
InvariantsDefined 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.

Control0..1
Typeuri
Is Modifiertrue
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.

InvariantsDefined 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.

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages A human language
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
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).

InvariantsDefined 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.

Control0..1
TypeNarrative
Alternate Namesnarrativehtmlxhtmldisplay
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.

InvariantsDefined 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.

Control0..*
TypeResource
Alternate Namesinline 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

An Extension

Control0..*
TypeExtension
InvariantsDefined 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())
SlicingThis element introduces a set of slices on Immunization.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. Immunization.extension:dueDateOfNextDose
SliceNamedueDateOfNextDose
Definition

次回接種を予定している日、期限

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(JP_Immunization_DueDateOfNextDose) (Extension Type: date)
InvariantsDefined 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.extension:manufacturedDate
SliceNamemanufacturedDate
Definition

ワクチンが製造された年月日

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(JP_Immunization_ManufacturedDate) (Extension Type: date)
InvariantsDefined 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())
11. Immunization.extension:certificatedDate
SliceNamecertificatedDate
Definition

ワクチンが検定された年月日

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(JP_Immunization_CertificatedDate) (Extension Type: date)
InvariantsDefined 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())
12. 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).

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensionsuser 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.

InvariantsDefined 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())
13. Immunization.identifier
Definition

A unique identifier assigned to this immunization record.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. Immunization.status
Definition

予防接種記録の現在の状態を示すコード

Control1..1
BindingThe codes SHALL be taken from ImmunizationStatusCodes 予防接種の現在の状態を表すコー
Typecode
Is Modifiertrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. Immunization.statusReason
Definition

Indicates the reason the immunization event was not performed.

Control0..1
BindingFor example codes, see ImmunizationStatusReasonCodes The reason why a vaccine was not administered
TypeCodeableConcept
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. Immunization.vaccineCode
Definition

接種されたあるいは接種予定のワクチン。

Control1..1
BindingThe codes SHOULD be taken from JP Core MedicationCode Immunization ValueSet
TypeCodeableConcept
Comments

全てのターミノロジがこのパターンに当てはまるわけではない。モデルによってはCodeableConceptではなく,独自構造でCodingを直接指定して文書やコーディング,その解釈や事前条件や事後条件との関連について示される。

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
17. Immunization.patient
Definition

予防接種を受けた,あるいは受けなかった患者。

Control1..1
TypeReference(JP_Patient))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
18. Immunization.encounter
Definition

患者が医療従事者から予防接種を受けた外来,入院あるいは他の対面の状態を表す。

Control0..1
TypeReference(JP_Encounter))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
19. Immunization.occurrence[x]
Definition

ワクチンを接種した日あるいは接種予定だった日。

Control1..1
TypeChoice of: dateTime, string
[x] NoteSee Choice of Data Types for further information about how to use [x]
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. Immunization.recorded
Definition

The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.

Control0..1
TypedateTime
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. 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.

Control0..1
Typeboolean
Comments

Reflects the “reliability” of the content.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. Immunization.reportOrigin
Definition

予防接種を実施した時に,ワクチンを接種した人以外からの報告からの情報である場合のデータの発生源。

Control0..1
BindingFor example codes, see ImmunizationOriginCodes The source of the data for a record which is not from a primary source
TypeCodeableConcept
Comments

Should not be populated if primarySource = True, not required even if primarySource = False.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. Immunization.location
Definition

接種医療機関。ワクチン接種がどこで実施されたかを表す。サービスが提供された場所。摂取された身体部位ではない。

Control0..1
TypeReference(JP_Location))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. Immunization.manufacturer
Definition

ワクチメーカーの名前。

Control0..1
TypeReference(JP_Organization))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. Immunization.lotNumber
Definition

ワクチン製剤のロット番号。

Control0..1
Typestring
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. Immunization.expirationDate
Definition

ワクチンの消費期限を表す日。

Control0..1
Typedate
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. Immunization.site
Definition

ワクチンが接種された身体部位

Control0..1
BindingFor example codes, see CodesForImmunizationSiteOfAdministration The site at which the vaccine was administered
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. Immunization.route
Definition

ワクチンが体内へと接種された経路。

Control0..1
BindingFor example codes, see ImmunizationRouteCodes The route by which the vaccine was administered
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Immunization.doseQuantity
Definition

ワクチン製剤が接種された量

Control0..1 This element is affected by the following invariants: ele-1
TypeQuantity(JP_MedicationSimpleQuantity)
Comments

薬剤に関する簡易的な数量と単位を定めている。ValueおよびCodeを必須とし、comparatorは記述不可。単位についてはMERIT9医薬品単位略号の利用を推進している。(SHOULD)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
qty-3: If a code for the unit is present, the system SHALL also be present (: code.empty() or system.exists())
sqty-1: The comparator is not used on a SimpleQuantity (: comparator.empty())
30. Immunization.performer
Definition

誰が予防接種を実施したかを表す。

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. 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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
32. 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.

Control0..*
TypeExtension
Alternate Namesextensionsuser 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.

InvariantsDefined 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.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).

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensionsuser 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.

InvariantsDefined 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())
34. Immunization.performer.function
Definition

Describes the type of performance (e.g. ordering provider, administering provider, etc.).

Control0..1
BindingThe 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
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. Immunization.performer.actor
Definition

The practitioner or organization who performed the action.

Control1..1
TypeReference(JP_PractitionerJP_PractitionerRoleJP_Organization))
Comments

When the individual practitioner who performed the action is known, it is best to send.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. Immunization.note
Definition

他の属性で伝達することができない予防接種に関する他の記録。

Control0..*
TypeAnnotation
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. Immunization.reasonCode
Definition

予防接種が行われた理由

Control0..*
BindingFor example codes, see ImmunizationReasonCodes The reason why a vaccine was administered
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. Immunization.reasonReference
Definition

予防接種が実施された理由を表すCondition,ObservationあるいはDiagnosticReportリソースを参照する。

Control0..*
TypeReference(ConditionObservationDiagnosticReport))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. Immunization.isSubpotent
Definition

量が通常の効力より弱いと考えられているかどうかを示す。デフォルトでは示されている量と同等の効力をもつと考えられている。

Control0..1
Typeboolean
Is Modifiertrue
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 MissingBy default, a dose should be considered to be potent.
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. Immunization.subpotentReason
Definition

効力が減弱すると考えられている理由。

Control0..*
BindingFor example codes, see ImmunizationSubpotentReason The reason why a dose is considered to be subpotent
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. Immunization.education
Definition

ワクチンを接種するときに患者(あるいは保護者)に提示された教材。

Control0..*
TypeBackboneElement
InvariantsDefined 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())
42. 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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
43. 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.

Control0..*
TypeExtension
Alternate Namesextensionsuser 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.

InvariantsDefined 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())
44. 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).

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensionsuser 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.

InvariantsDefined 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())
45. Immunization.education.documentType
Definition

Identifier of the material presented to the patient.

Control0..1
Typestring
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. Immunization.education.reference
Definition

Reference pointer to the educational material given to the patient if the information was on line.

Control0..1
Typeuri
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. Immunization.education.publicationDate
Definition

Date the educational material was published.

Control0..1
TypedateTime
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
48. Immunization.education.presentationDate
Definition

Date the educational material was given to the patient.

Control0..1
TypedateTime
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. Immunization.programEligibility
Definition

ワクチン接種計画での患者適格性を示す

Control0..*
BindingFor example codes, see ImmunizationProgramEligibility The patient's eligibility for a vaccation program
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. Immunization.fundingSource
Definition

ワクチンが実際に接種されるときの資金源を示す。これは患者適格性(たとえば,公的に購入されたワクチンには適格性があるが,在庫の問題で私的資金で購入されたワクチンを投与するような場合)とは異なることがある。

Control0..1
BindingFor example codes, see ImmunizationFundingSource The source of funding used to purchase the vaccine administered
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. Immunization.reaction
Definition

予防接種に関連する時期に発生した副反応を示す分類されたデータ。

Control0..*
TypeBackboneElement
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. 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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
53. 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.

Control0..*
TypeExtension
Alternate Namesextensionsuser 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.

InvariantsDefined 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())
54. 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).

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensionsuser 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.

InvariantsDefined 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())
55. Immunization.reaction.date
Definition

Date of reaction to the immunization.

Control0..1
TypedateTime
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
56. Immunization.reaction.detail
Definition

Details of the reaction.

Control0..1
TypeReference(Observation))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
57. Immunization.reaction.reported
Definition

Self-reported indicator.

Control0..1
Typeboolean
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
58. Immunization.protocolApplied
Definition

ワクチンを接種した提供者が実施したプロトコール(推奨される手順の集合)。

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
59. 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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
60. 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.

Control0..*
TypeExtension
Alternate Namesextensionsuser 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.

InvariantsDefined 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.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).

Control0..*
TypeExtension
Is Modifiertrue
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 Namesextensionsuser 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.

InvariantsDefined 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())
62. Immunization.protocolApplied.series
Definition

One possible path to achieve presumed immunity against a disease - within the context of an authority.

Control0..1
Typestring
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
63. Immunization.protocolApplied.authority
Definition

Indicates the authority who published the protocol (e.g. ACIP) that is being followed.

Control0..1
TypeReference(Organization))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
64. Immunization.protocolApplied.targetDisease
Definition

The vaccine preventable disease the dose is being administered against.

Control0..*
BindingFor example codes, see ImmunizationTargetDiseaseCodes The vaccine preventable disease the dose is being administered for
TypeCodeableConcept
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
65. Immunization.protocolApplied.doseNumber[x]
Definition

Nominal position in a series.

Control1..1
TypeChoice of: positiveInt, string
[x] NoteSee 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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
66. Immunization.protocolApplied.seriesDoses[x]
Definition

The recommended number of doses to achieve immunity.

Control0..1
TypeChoice of: positiveInt, string
[x] NoteSee 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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))