This page is part of the 臺灣核心實作指引(TW Core IG) (v1.0.0: Releases) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Active as of 2025-12-10 |
Definitions for the Immunization-twcore resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. 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. |
| Short | 疫苗接種Immunization event information |
| Control | 0..* |
| Is Modifier | false |
| Must Support | false |
| Summary | false |
| Invariants | 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()) tw-core-10: SHOULD have a translation to the NDC value set ( vaccineCode.coding.where(system='http://hl7.org/fhir/sid/cvx').exists() implies vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').exists()) |
| 2. Immunization.implicitRules | |
| Definition | 構建 resource 時遵循的一系列規則的參照,在處理內容時必須理解這些規則。通常這是對 IG 所定義之特殊規則及其他 profiles 的參照。 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. |
| Short | 創建此內容所依據的一組規則A set of rules under which this content was created |
| 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. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| Invariants | 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). |
| Short | 擴充內容可能會改變資源解釋方式Extensions that cannot be ignored |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them |
| 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 |
| Invariants | 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.status | |
| Definition | 疫苗接種事件的狀態,表示是否完成接種、記錄有誤或未接種。 Indicates the current status of the immunization event. |
| Short | completed | entered-in-error | not-done |
| 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. |
| Control | 1..1 |
| Binding | The codes SHALL be taken from ImmunizationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-status|4.0.1 (required to http://hl7.org/fhir/ValueSet/immunization-status|4.0.1)A set of codes indicating the current status of an Immunization. |
| Type | code |
| Is Modifier | true because This element is labeled as a modifier because it is a status element that contains statuses entered-in-error and not-done which means that the resource should not be treated as valid |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. Immunization.statusReason | |
| Definition | 表示為什麼疫苗接種未完成的原因,例如:禁忌症、病患拒絕等。 Indicates the reason the immunization event was not performed. |
| Short | 接種未完成的原因Reason not done |
| 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. |
| Control | 0..1 |
| Binding | For example codes, see ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reason|4.0.1 (example to http://hl7.org/fhir/ValueSet/immunization-status-reason|4.0.1)The reason why a vaccine was not administered. |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. Immunization.vaccineCode | |
| Definition | 用於識別施打的疫苗種類或類型。 Vaccine that was administered or was to be administered. |
| Short | 疫苗產品類型 (綁定到 CVX 疫苗代碼系統)Vaccine product administered |
| Control | 1..1 This element is affected by the following invariants: tw-core-10 |
| Binding | Unless not suitable, these codes SHALL be taken from For example codes, see VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-code|4.0.1 (extensible to http://hl7.org/fhir/ValueSet/vaccine-code) |
| Type | CodeableConcept |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | 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. |
| Short | 接種疫苗的病患Who was immunized |
| Control | 1..1 |
| Type | Reference(TW Core Patient, Patient) |
| Is Modifier | false |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 14. Immunization.encounter | |
| Definition | 表示疫苗接種發生時的就醫事件參照。 The visit or admission or other contact between patient and health care provider the immunization was performed as part of. |
| Short | 與疫苗接種相關的就醫事件Encounter immunization was part of |
| Control | 0..1 |
| Type | Reference(TW Core Encounter, Encounter) |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | 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. |
| Short | 疫苗接種的發生日期/時間Vaccine administration date |
| 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. |
| Control | 1..1 |
| Type | Choice of: dateTime, string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Must Support Types | dateTime |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 18. 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. |
| Short | 資料來源是否為主要來源Indicates context the data was recorded in |
| Comments | Reflects the “reliability” of the content. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | false |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 20. Immunization.location | |
| Definition | 進行疫苗接種的實際地點,如醫療院所、診所等。 The service delivery location where the vaccine administration occurred. |
| Short | 疫苗接種的地點Where immunization occurred |
| Control | 0..1 |
| Type | Reference(TW Core Location, Location) |
| Is Modifier | false |
| Must Support | true |
| Summary | false |
| Invariants | 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. |
| Short | 疫苗製造商Vaccine manufacturer |
| Control | 0..1 |
| Type | Reference(TW Core Organization, Organization) |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 24. Immunization.reasonReference | |
| Definition | 進行此次疫苗接種的醫療原因參照,例如:特定疾病、臨床觀察或診斷報告。 Condition, Observation or DiagnosticReport that supports why the immunization was administered. |
| Short | 接種疫苗的原因Why immunization occurred |
| Control | 0..* |
| Type | Reference(TW Core Condition, TW Core Observation Clinical Result, TW Core DiagnosticReport, Condition, Observation, DiagnosticReport) |
| Is Modifier | false |
| Summary | false |
| Invariants | 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. |
| Short | 疫苗效價是否低於標準Dose potency |
| 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. |
| Control | 0..1 |
| Type | boolean |
| Is Modifier | true because This element is labeled as a modifier because an immunization event with a subpotent vaccine doesn't protect the patient the same way as a potent dose. |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Summary | true |
| Meaning if Missing | By default, a dose should be considered to be potent. |
| Invariants | 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 foundhere
| 0. Immunization | |
| Definition | 疫苗接種的記錄,包含接種的疫苗及事件的相關資訊。 |
| Short | 疫苗接種 |
| Must Support | false |
| Invariants | tw-core-10: SHOULD have a translation to the NDC value set (vaccineCode.coding.where(system='http://hl7.org/fhir/sid/cvx').exists() implies vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').exists()) |
| 2. Immunization.implicitRules | |
| Definition | 構建 resource 時遵循的一系列規則的參照,在處理內容時必須理解這些規則。通常這是對 IG 所定義之特殊規則及其他 profiles 的參照。 |
| Short | 創建此內容所依據的一組規則 |
| 4. Immunization.modifierExtension | |
| Definition | 可以修改標準資源解釋的擴充內容。擴展內容通常會增加其他屬性,但不會更改基本解釋。在理解修改擴展內容之前不應該解釋此疫苗接種資源。 |
| Short | 擴充內容可能會改變資源解釋方式 |
| 6. Immunization.status | |
| Definition | 疫苗接種事件的狀態,表示是否完成接種、記錄有誤或未接種。 |
| Must Support | true |
| 8. Immunization.statusReason | |
| Definition | 表示為什麼疫苗接種未完成的原因,例如:禁忌症、病患拒絕等。 |
| Short | 接種未完成的原因 |
| Must Support | true |
| 10. Immunization.vaccineCode | |
| Definition | 用於識別施打的疫苗種類或類型。 |
| Short | 疫苗產品類型 (綁定到 CVX 疫苗代碼系統) |
| Binding | Unless not suitable, these codes SHALL be taken from VaccineAdministeredValueSet (extensible to http://hl7.org/fhir/ValueSet/vaccine-code) |
| Must Support | true |
| 12. Immunization.patient | |
| Definition | 接受疫苗接種的患者參照。 |
| Short | 接種疫苗的病患 |
| Type | Reference(TW Core Patient) |
| Must Support | true |
| 14. Immunization.encounter | |
| Definition | 表示疫苗接種發生時的就醫事件參照。 |
| Short | 與疫苗接種相關的就醫事件 |
| Type | Reference(TW Core Encounter) |
| Must Support | true |
| 16. Immunization.occurrence[x] | |
| Definition | 疫苗接種發生的日期與時間,或以字串描述的大概時間。 |
| Short | 疫苗接種的發生日期/時間 |
| Type | Choice of: dateTime, string |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Must Support Types | dateTime |
| 18. Immunization.primarySource | |
| Definition | 指示記錄的資訊是否來自主要來源 (如接種疫苗的人員),或是從次要來源 (如病患本人回報) 取得。 |
| Short | 資料來源是否為主要來源 |
| Must Support | true |
| 20. Immunization.location | |
| Definition | 進行疫苗接種的實際地點,如醫療院所、診所等。 |
| Short | 疫苗接種的地點 |
| Type | Reference(TW Core Location) |
| Must Support | true |
| 22. Immunization.manufacturer | |
| Definition | 疫苗製造商的參照。 |
| Short | 疫苗製造商 |
| Type | Reference(TW Core Organization) |
| 24. Immunization.performer | |
| 26. Immunization.performer.actor | |
| Definition | 參與疫苗接種的醫療人員、醫療人員角色或組織的參照。 |
| Short | 執行疫苗接種的人員或組織 |
| Type | Reference(TW Core Practitioner, TW Core PractitionerRole, TW Core Organization) |
| 28. Immunization.reasonReference | |
| Definition | 進行此次疫苗接種的醫療原因參照,例如:特定疾病、臨床觀察或診斷報告。 |
| Short | 接種疫苗的原因 |
| Type | Reference(TW Core Condition, TW Core Observation Clinical Result, TW Core DiagnosticReport) |
| 30. Immunization.isSubpotent | |
| Definition | 表明接種的疫苗劑量是否已知低於建議量的標示,例如:部分劑量因患者移動而造成施打不完整、或完整劑量分成多次施打。 |
| Short | 疫苗效價是否低於標準 |
| Must Support | true |
| 32. Immunization.reaction | |
| 34. Immunization.reaction.detail | |
| Definition | 疫苗接種後發生的不良反應參照,例如:過敏反應、發燒等臨床結果觀察。 |
| Short | 接種後反應的細節 |
| Type | Reference(TW Core Observation Clinical Result) |
| 36. Immunization.protocolApplied | |
| 38. Immunization.protocolApplied.authority | |
| Definition | 提供或授權此疫苗接種計劃的組織參照。 |
| Short | 疫苗接種計劃的權責組織 |
| Type | Reference(TW Core Organization) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Immunization | |||||
| Definition | 疫苗接種的記錄,包含接種的疫苗及事件的相關資訊。 | ||||
| Short | 疫苗接種 | ||||
| Control | 0..* | ||||
| Is Modifier | false | ||||
| Must Support | false | ||||
| Summary | false | ||||
| Invariants | 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())tw-core-10: SHOULD have a translation to the NDC value set ( vaccineCode.coding.where(system='http://hl7.org/fhir/sid/cvx').exists() implies vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').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. | ||||
| Short | Logical id of this artifact | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| 4. 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. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 6. Immunization.implicitRules | |||||
| Definition | 構建 resource 時遵循的一系列規則的參照,在處理內容時必須理解這些規則。通常這是對 IG 所定義之特殊規則及其他 profiles 的參照。 | ||||
| Short | 創建此內容所依據的一組規則 | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 8. Immunization.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| 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). | ||||
| Control | 0..1 | ||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| ||||
| Type | code | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 10. 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. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | Narrative | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 12. 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. | ||||
| Short | Contained, inline 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. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 14. 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. | ||||
| Short | Additional content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | 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()) | ||||
| 16. Immunization.modifierExtension | |||||
| Definition | 可以修改標準資源解釋的擴充內容。擴展內容通常會增加其他屬性,但不會更改基本解釋。在理解修改擴展內容之前不應該解釋此疫苗接種資源。 | ||||
| Short | 擴充內容可能會改變資源解釋方式 | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| 18. Immunization.identifier | |||||
| Definition | A unique identifier assigned to this immunization record. | ||||
| Short | Business identifier | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 20. Immunization.status | |||||
| Definition | 疫苗接種事件的狀態,表示是否完成接種、記錄有誤或未接種。 | ||||
| Short | completed | entered-in-error | not-done | ||||
| 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. | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from ImmunizationStatusCodes (required to http://hl7.org/fhir/ValueSet/immunization-status|4.0.1)A set of codes indicating the current status of an Immunization. | ||||
| Type | code | ||||
| Is Modifier | true because This element is labeled as a modifier because it is a status element that contains statuses entered-in-error and not-done which means that the resource should not be treated as valid | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 22. Immunization.statusReason | |||||
| Definition | 表示為什麼疫苗接種未完成的原因,例如:禁忌症、病患拒絕等。 | ||||
| Short | 接種未完成的原因 | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see ImmunizationStatusReasonCodes (example to http://hl7.org/fhir/ValueSet/immunization-status-reason|4.0.1)The reason why a vaccine was not administered. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 24. Immunization.vaccineCode | |||||
| Definition | 用於識別施打的疫苗種類或類型。 | ||||
| Short | 疫苗產品類型 (綁定到 CVX 疫苗代碼系統) | ||||
| Control | 1..1 This element is affected by the following invariants: tw-core-10 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from VaccineAdministeredValueSet (extensible to http://hl7.org/fhir/ValueSet/vaccine-code) | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 26. Immunization.patient | |||||
| Definition | 接受疫苗接種的患者參照。 | ||||
| Short | 接種疫苗的病患 | ||||
| Control | 1..1 | ||||
| Type | Reference(TW Core Patient) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 28. Immunization.encounter | |||||
| Definition | 表示疫苗接種發生時的就醫事件參照。 | ||||
| Short | 與疫苗接種相關的就醫事件 | ||||
| Control | 0..1 | ||||
| Type | Reference(TW Core Encounter) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 30. Immunization.occurrence[x] | |||||
| Definition | 疫苗接種發生的日期與時間,或以字串描述的大概時間。 | ||||
| Short | 疫苗接種的發生日期/時間 | ||||
| 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. | ||||
| Control | 1..1 | ||||
| Type | Choice of: dateTime, string | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Must Support Types | dateTime | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 32. Immunization.recorded | |||||
| Definition | The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event. | ||||
| Short | When the immunization was first captured in the subject's record | ||||
| Control | 0..1 | ||||
| Type | dateTime | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 34. Immunization.primarySource | |||||
| Definition | 指示記錄的資訊是否來自主要來源 (如接種疫苗的人員),或是從次要來源 (如病患本人回報) 取得。 | ||||
| Short | 資料來源是否為主要來源 | ||||
| Comments | Reflects the “reliability” of the content. | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 36. 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. | ||||
| Short | Indicates the source of a secondarily reported record | ||||
| Comments | Should not be populated if primarySource = True, not required even if primarySource = False. | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see ImmunizationOriginCodes (example to http://hl7.org/fhir/ValueSet/immunization-origin|4.0.1)The source of the data for a record which is not from a primary source. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 38. Immunization.location | |||||
| Definition | 進行疫苗接種的實際地點,如醫療院所、診所等。 | ||||
| Short | 疫苗接種的地點 | ||||
| Control | 0..1 | ||||
| Type | Reference(TW Core Location) | ||||
| Is Modifier | false | ||||
| Must Support | true | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 40. Immunization.manufacturer | |||||
| Definition | 疫苗製造商的參照。 | ||||
| Short | 疫苗製造商 | ||||
| Control | 0..1 | ||||
| Type | Reference(TW Core Organization) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 42. Immunization.lotNumber | |||||
| Definition | Lot number of the vaccine product. | ||||
| Short | Vaccine lot number | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 44. Immunization.expirationDate | |||||
| Definition | Date vaccine batch expires. | ||||
| Short | Vaccine expiration date | ||||
| Control | 0..1 | ||||
| Type | date | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 46. Immunization.site | |||||
| Definition | Body site where vaccine was administered. | ||||
| Short | Body site vaccine was administered | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see CodesForImmunizationSiteOfAdministration (example to http://hl7.org/fhir/ValueSet/immunization-site|4.0.1)The site at which the vaccine was administered. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 48. Immunization.route | |||||
| Definition | The path by which the vaccine product is taken into the body. | ||||
| Short | How vaccine entered body | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see ImmunizationRouteCodes (example to http://hl7.org/fhir/ValueSet/immunization-route|4.0.1)The route by which the vaccine was administered. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 50. Immunization.doseQuantity | |||||
| Definition | The quantity of vaccine product that was administered. | ||||
| Short | Amount of vaccine administered | ||||
| Control | 0..1 | ||||
| Type | Quantity(SimpleQuantity) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 52. Immunization.performer | |||||
| Definition | Indicates who performed the immunization event. | ||||
| Short | Who performed event | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 54. 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. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 56. 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. | ||||
| Short | Additional content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | 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()) | ||||
| 58. 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). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| 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 | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 60. Immunization.performer.function | |||||
| Definition | Describes the type of performance (e.g. ordering provider, administering provider, etc.). | ||||
| Short | What type of performance was done | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from ImmunizationFunctionCodes (extensible to http://hl7.org/fhir/ValueSet/immunization-function|4.0.1)The role a practitioner or organization plays in the immunization event. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 62. Immunization.performer.actor | |||||
| Definition | 參與疫苗接種的醫療人員、醫療人員角色或組織的參照。 | ||||
| Short | 執行疫苗接種的人員或組織 | ||||
| Comments | When the individual practitioner who performed the action is known, it is best to send. | ||||
| Control | 1..1 | ||||
| Type | Reference(TW Core Practitioner, TW Core PractitionerRole, TW Core Organization) | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 64. Immunization.note | |||||
| Definition | Extra information about the immunization that is not conveyed by the other attributes. | ||||
| Short | Additional immunization notes | ||||
| Control | 0..* | ||||
| Type | Annotation | ||||
| Is Modifier | false | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 66. Immunization.reasonCode | |||||
| Definition | Reasons why the vaccine was administered. | ||||
| Short | Why immunization occurred | ||||
| Control | 0..* | ||||
| Binding | For example codes, see ImmunizationReasonCodes (example to http://hl7.org/fhir/ValueSet/immunization-reason|4.0.1)The reason why a vaccine was administered. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 68. Immunization.reasonReference | |||||
| Definition | 進行此次疫苗接種的醫療原因參照,例如:特定疾病、臨床觀察或診斷報告。 | ||||
| Short | 接種疫苗的原因 | ||||
| Control | 0..* | ||||
| Type | Reference(TW Core Condition, TW Core Observation Clinical Result, TW Core DiagnosticReport) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 70. Immunization.isSubpotent | |||||
| Definition | 表明接種的疫苗劑量是否已知低於建議量的標示,例如:部分劑量因患者移動而造成施打不完整、或完整劑量分成多次施打。 | ||||
| Short | 疫苗效價是否低於標準 | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | true because This element is labeled as a modifier because an immunization event with a subpotent vaccine doesn't protect the patient the same way as a potent dose. | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Must Support | true | ||||
| Summary | true | ||||
| Meaning if Missing | By default, a dose should be considered to be potent. | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 72. Immunization.subpotentReason | |||||
| Definition | Reason why a dose is considered to be subpotent. | ||||
| Short | Reason for being subpotent | ||||
| Control | 0..* | ||||
| Binding | For example codes, see ImmunizationSubpotentReason (example to http://hl7.org/fhir/ValueSet/immunization-subpotent-reason|4.0.1)The reason why a dose is considered to be subpotent. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 74. Immunization.education | |||||
| Definition | Educational material presented to the patient (or guardian) at the time of vaccine administration. | ||||
| Short | Educational material presented to patient | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | 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()) | ||||
| 76. 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. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 78. 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. | ||||
| Short | Additional content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | 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()) | ||||
| 80. 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). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| 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 | ||||
| Invariants | 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()) | ||||
| 82. Immunization.education.documentType | |||||
| Definition | Identifier of the material presented to the patient. | ||||
| Short | Educational material document identifier | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 84. Immunization.education.reference | |||||
| Definition | Reference pointer to the educational material given to the patient if the information was on line. | ||||
| Short | Educational material reference pointer | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 86. Immunization.education.publicationDate | |||||
| Definition | Date the educational material was published. | ||||
| Short | Educational material publication date | ||||
| Control | 0..1 | ||||
| Type | dateTime | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 88. Immunization.education.presentationDate | |||||
| Definition | Date the educational material was given to the patient. | ||||
| Short | Educational material presentation date | ||||
| Control | 0..1 | ||||
| Type | dateTime | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 90. Immunization.programEligibility | |||||
| Definition | Indicates a patient's eligibility for a funding program. | ||||
| Short | Patient eligibility for a vaccination program | ||||
| Control | 0..* | ||||
| Binding | For example codes, see ImmunizationProgramEligibility (example to http://hl7.org/fhir/ValueSet/immunization-program-eligibility|4.0.1)The patient's eligibility for a vaccation program. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 92. 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). | ||||
| Short | Funding source for the vaccine | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see ImmunizationFundingSource (example to http://hl7.org/fhir/ValueSet/immunization-funding-source|4.0.1)The source of funding used to purchase the vaccine administered. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 94. Immunization.reaction | |||||
| Definition | Categorical data indicating that an adverse event is associated in time to an immunization. | ||||
| Short | Details of a reaction that follows immunization | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 96. 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. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 98. 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. | ||||
| Short | Additional content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | 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()) | ||||
| 100. 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). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| 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 | ||||
| Invariants | 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()) | ||||
| 102. Immunization.reaction.date | |||||
| Definition | Date of reaction to the immunization. | ||||
| Short | When reaction started | ||||
| Control | 0..1 | ||||
| Type | dateTime | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 104. Immunization.reaction.detail | |||||
| Definition | 疫苗接種後發生的不良反應參照,例如:過敏反應、發燒等臨床結果觀察。 | ||||
| Short | 接種後反應的細節 | ||||
| Control | 0..1 | ||||
| Type | Reference(TW Core Observation Clinical Result) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 106. Immunization.reaction.reported | |||||
| Definition | Self-reported indicator. | ||||
| Short | Indicates self-reported reaction | ||||
| Control | 0..1 | ||||
| Type | boolean | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 108. Immunization.protocolApplied | |||||
| Definition | The protocol (set of recommendations) being followed by the provider who administered the dose. | ||||
| Short | Protocol followed by the provider | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 110. 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. | ||||
| Short | Unique id for inter-element referencing | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Summary | false | ||||
| 112. 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. | ||||
| Short | Additional content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Alternate Names | extensions, user content | ||||
| Invariants | 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()) | ||||
| 114. 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). | ||||
| Short | Extensions that cannot be ignored even if unrecognized | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||
| 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 | ||||
| Invariants | 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()) | ||||
| 116. Immunization.protocolApplied.series | |||||
| Definition | One possible path to achieve presumed immunity against a disease - within the context of an authority. | ||||
| Short | Name of vaccine series | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 118. Immunization.protocolApplied.authority | |||||
| Definition | 提供或授權此疫苗接種計劃的組織參照。 | ||||
| Short | 疫苗接種計劃的權責組織 | ||||
| Control | 0..1 | ||||
| Type | Reference(TW Core Organization) | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 120. Immunization.protocolApplied.targetDisease | |||||
| Definition | The vaccine preventable disease the dose is being administered against. | ||||
| Short | Vaccine preventatable disease being targetted | ||||
| Control | 0..* | ||||
| Binding | For example codes, see ImmunizationTargetDiseaseCodes (example to http://hl7.org/fhir/ValueSet/immunization-target-disease|4.0.1)The vaccine preventable disease the dose is being administered for. | ||||
| Type | CodeableConcept | ||||
| Is Modifier | false | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 122. Immunization.protocolApplied.doseNumber[x] | |||||
| Definition | Nominal position in a series. | ||||
| Short | Dose number within series | ||||
| 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). | ||||
| Control | 1..1 | ||||
| Type | Choice of: positiveInt, string | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||
| 124. Immunization.protocolApplied.seriesDoses[x] | |||||
| Definition | The recommended number of doses to achieve immunity. | ||||
| Short | Recommended number of doses for immunity | ||||
| 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). | ||||
| Control | 0..1 | ||||
| Type | Choice of: positiveInt, string | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Is Modifier | false | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||